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 |
Retrieves the metadata of the specified folder.
- getFolder :: Text -> GetFolder
- data GetFolder
- gfAuthenticationToken :: Lens' GetFolder (Maybe Text)
- gfIncludeCustomMetadata :: Lens' GetFolder (Maybe Bool)
- gfFolderId :: Lens' GetFolder Text
- getFolderResponse :: Int -> GetFolderResponse
- data GetFolderResponse
- gfrsCustomMetadata :: Lens' GetFolderResponse (HashMap Text Text)
- gfrsMetadata :: Lens' GetFolderResponse (Maybe FolderMetadata)
- gfrsResponseStatus :: Lens' GetFolderResponse Int
Creating a Request
Creates a value of GetFolder
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
gfAuthenticationToken
- Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.gfIncludeCustomMetadata
- Set to TRUE to include custom metadata in the response.gfFolderId
- The ID of the folder.
See: getFolder
smart constructor.
Request Lenses
gfAuthenticationToken :: Lens' GetFolder (Maybe Text) Source #
Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.
gfIncludeCustomMetadata :: Lens' GetFolder (Maybe Bool) Source #
Set to TRUE to include custom metadata in the response.
Destructuring the Response
Creates a value of GetFolderResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
gfrsCustomMetadata
- The custom metadata on the folder.gfrsMetadata
- The metadata of the folder.gfrsResponseStatus
- -- | The response status code.
data GetFolderResponse Source #
See: getFolderResponse
smart constructor.
Response Lenses
gfrsCustomMetadata :: Lens' GetFolderResponse (HashMap Text Text) Source #
The custom metadata on the folder.
gfrsMetadata :: Lens' GetFolderResponse (Maybe FolderMetadata) Source #
The metadata of the folder.
gfrsResponseStatus :: Lens' GetFolderResponse Int Source #
- - | The response status code.