Describe Document Versions

workdocs_describe_document_versions

R Documentation

Retrieves the document versions for the specified document

Description

Retrieves the document versions for the specified document.

By default, only active versions are returned.

Usage

workdocs_describe_document_versions(AuthenticationToken, DocumentId,
  Marker, Limit, Include, Fields)

Arguments

AuthenticationToken

Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

DocumentId

[required] The ID of the document.

Marker

The marker for the next set of results. (You received this marker from a previous call.)

Limit

The maximum number of versions to return with this call.

Include

A comma-separated list of values. Specify "INITIALIZED" to include incomplete versions.

Fields

Specify "SOURCE" to include initialized versions and a URL for the source document.

Value

A list with the following syntax:

list(
  DocumentVersions = list(
    list(
      Id = "string",
      Name = "string",
      ContentType = "string",
      Size = 123,
      Signature = "string",
      Status = "INITIALIZED"|"ACTIVE",
      CreatedTimestamp = as.POSIXct(
        "2015-01-01"
      ),
      ModifiedTimestamp = as.POSIXct(
        "2015-01-01"
      ),
      ContentCreatedTimestamp = as.POSIXct(
        "2015-01-01"
      ),
      ContentModifiedTimestamp = as.POSIXct(
        "2015-01-01"
      ),
      CreatorId = "string",
      Thumbnail = list(
        "string"
      ),
      Source = list(
        "string"
      )
    )
  ),
  Marker = "string"
)

Request syntax

svc$describe_document_versions(
  AuthenticationToken = "string",
  DocumentId = "string",
  Marker = "string",
  Limit = 123,
  Include = "string",
  Fields = "string"
)