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 details of a document.
- getDocument :: Text -> GetDocument
- data GetDocument
- gdAuthenticationToken :: Lens' GetDocument (Maybe Text)
- gdIncludeCustomMetadata :: Lens' GetDocument (Maybe Bool)
- gdDocumentId :: Lens' GetDocument Text
- getDocumentResponse :: Int -> GetDocumentResponse
- data GetDocumentResponse
- gdrsCustomMetadata :: Lens' GetDocumentResponse (HashMap Text Text)
- gdrsMetadata :: Lens' GetDocumentResponse (Maybe DocumentMetadata)
- gdrsResponseStatus :: Lens' GetDocumentResponse Int
Creating a Request
Creates a value of GetDocument
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
gdAuthenticationToken
- Amazon WorkDocs authentication token. This field should not be set when using administrative API actions, as in accessing the API using AWS credentials.gdIncludeCustomMetadata
- Set this toTRUE
to include custom metadata in the response.gdDocumentId
- The ID of the document.
data GetDocument Source #
See: getDocument
smart constructor.
Request Lenses
gdAuthenticationToken :: Lens' GetDocument (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.
gdIncludeCustomMetadata :: Lens' GetDocument (Maybe Bool) Source #
Set this to TRUE
to include custom metadata in the response.
gdDocumentId :: Lens' GetDocument Text Source #
The ID of the document.
Destructuring the Response
Creates a value of GetDocumentResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
gdrsCustomMetadata
- The custom metadata on the document.gdrsMetadata
- The metadata details of the document.gdrsResponseStatus
- -- | The response status code.
data GetDocumentResponse Source #
See: getDocumentResponse
smart constructor.
Response Lenses
gdrsCustomMetadata :: Lens' GetDocumentResponse (HashMap Text Text) Source #
The custom metadata on the document.
gdrsMetadata :: Lens' GetDocumentResponse (Maybe DocumentMetadata) Source #
The metadata details of the document.
gdrsResponseStatus :: Lens' GetDocumentResponse Int Source #
- - | The response status code.