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 requested document.
By default, Amazon WorkDocs returns a maximum of 100 levels upwards from the requested document 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 names of the parent folders.
- getDocumentPath :: Text -> GetDocumentPath
- data GetDocumentPath
- gdpAuthenticationToken :: Lens' GetDocumentPath (Maybe Text)
- gdpMarker :: Lens' GetDocumentPath (Maybe Text)
- gdpLimit :: Lens' GetDocumentPath (Maybe Natural)
- gdpFields :: Lens' GetDocumentPath (Maybe Text)
- gdpDocumentId :: Lens' GetDocumentPath Text
- getDocumentPathResponse :: Int -> GetDocumentPathResponse
- data GetDocumentPathResponse
- gdprsPath :: Lens' GetDocumentPathResponse (Maybe ResourcePath)
- gdprsResponseStatus :: Lens' GetDocumentPathResponse Int
Creating a Request
Creates a value of GetDocumentPath
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
gdpAuthenticationToken
- Amazon WorkDocs authentication token. This field should not be set when using administrative API actions, as in accessing the API using AWS credentials.gdpMarker
- This value is not supported.gdpLimit
- The maximum number of levels in the hierarchy to return.gdpFields
- A comma-separated list of values. SpecifyNAME
to include the names of the parent folders.gdpDocumentId
- The ID of the document.
data GetDocumentPath Source #
See: getDocumentPath
smart constructor.
Request Lenses
gdpAuthenticationToken :: Lens' GetDocumentPath (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.
gdpLimit :: Lens' GetDocumentPath (Maybe Natural) Source #
The maximum number of levels in the hierarchy to return.
gdpFields :: Lens' GetDocumentPath (Maybe Text) Source #
A comma-separated list of values. Specify NAME
to include the names of the parent folders.
gdpDocumentId :: Lens' GetDocumentPath Text Source #
The ID of the document.
Destructuring the Response
getDocumentPathResponse Source #
Creates a value of GetDocumentPathResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
gdprsPath
- The path information.gdprsResponseStatus
- -- | The response status code.
data GetDocumentPathResponse Source #
See: getDocumentPathResponse
smart constructor.
Response Lenses
gdprsPath :: Lens' GetDocumentPathResponse (Maybe ResourcePath) Source #
The path information.
gdprsResponseStatus :: Lens' GetDocumentPathResponse Int Source #
- - | The response status code.