Get Document Version

workdocs_get_document_version

R Documentation

Retrieves version metadata for the specified document¶

Description¶

Retrieves version metadata for the specified document.

Usage¶

workdocs_get_document_version(AuthenticationToken, DocumentId,
  VersionId, Fields, IncludeCustomMetadata)

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.

VersionId

[required] The version ID of the document.

Fields

A comma-separated list of values. Specify "SOURCE" to include a URL for the source document.

IncludeCustomMetadata

Set this to TRUE to include custom metadata in the response.

Value¶

A list with the following syntax:

list(
  Metadata = 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"
    )
  ),
  CustomMetadata = list(
    "string"
  )
)

Request syntax¶

svc$get_document_version(
  AuthenticationToken = "string",
  DocumentId = "string",
  VersionId = "string",
  Fields = "string",
  IncludeCustomMetadata = TRUE|FALSE
)