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 document versions for the specified document.
By default, only active versions are returned.
This operation returns paginated results.
- describeDocumentVersions :: Text -> DescribeDocumentVersions
- data DescribeDocumentVersions
- ddvInclude :: Lens' DescribeDocumentVersions (Maybe Text)
- ddvAuthenticationToken :: Lens' DescribeDocumentVersions (Maybe Text)
- ddvMarker :: Lens' DescribeDocumentVersions (Maybe Text)
- ddvLimit :: Lens' DescribeDocumentVersions (Maybe Natural)
- ddvFields :: Lens' DescribeDocumentVersions (Maybe Text)
- ddvDocumentId :: Lens' DescribeDocumentVersions Text
- describeDocumentVersionsResponse :: Int -> DescribeDocumentVersionsResponse
- data DescribeDocumentVersionsResponse
- ddvrsDocumentVersions :: Lens' DescribeDocumentVersionsResponse [DocumentVersionMetadata]
- ddvrsMarker :: Lens' DescribeDocumentVersionsResponse (Maybe Text)
- ddvrsResponseStatus :: Lens' DescribeDocumentVersionsResponse Int
Creating a Request
describeDocumentVersions Source #
Creates a value of DescribeDocumentVersions
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ddvInclude
- A comma-separated list of values. Specify INITIALIZED to include incomplete versions.ddvAuthenticationToken
- Amazon WorkDocs authentication token. This field should not be set when using administrative API actions, as in accessing the API using AWS credentials.ddvMarker
- The marker for the next set of results. (You received this marker from a previous call.)ddvLimit
- The maximum number of versions to return with this call.ddvFields
- Specify SOURCE to include initialized versions and a URL for the source document.ddvDocumentId
- The ID of the document.
data DescribeDocumentVersions Source #
See: describeDocumentVersions
smart constructor.
Request Lenses
ddvInclude :: Lens' DescribeDocumentVersions (Maybe Text) Source #
A comma-separated list of values. Specify INITIALIZED to include incomplete versions.
ddvAuthenticationToken :: Lens' DescribeDocumentVersions (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.
ddvMarker :: Lens' DescribeDocumentVersions (Maybe Text) Source #
The marker for the next set of results. (You received this marker from a previous call.)
ddvLimit :: Lens' DescribeDocumentVersions (Maybe Natural) Source #
The maximum number of versions to return with this call.
ddvFields :: Lens' DescribeDocumentVersions (Maybe Text) Source #
Specify SOURCE to include initialized versions and a URL for the source document.
ddvDocumentId :: Lens' DescribeDocumentVersions Text Source #
The ID of the document.
Destructuring the Response
describeDocumentVersionsResponse Source #
Creates a value of DescribeDocumentVersionsResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ddvrsDocumentVersions
- The document versions.ddvrsMarker
- The marker to use when requesting the next set of results. If there are no additional results, the string is empty.ddvrsResponseStatus
- -- | The response status code.
data DescribeDocumentVersionsResponse Source #
See: describeDocumentVersionsResponse
smart constructor.
Response Lenses
ddvrsDocumentVersions :: Lens' DescribeDocumentVersionsResponse [DocumentVersionMetadata] Source #
The document versions.
ddvrsMarker :: Lens' DescribeDocumentVersionsResponse (Maybe Text) Source #
The marker to use when requesting the next set of results. If there are no additional results, the string is empty.
ddvrsResponseStatus :: Lens' DescribeDocumentVersionsResponse Int Source #
- - | The response status code.