Get Document

workdocs_get_document

R Documentation

Retrieves details of a document

Description

Retrieves details of a document.

Usage

workdocs_get_document(AuthenticationToken, DocumentId,
  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.

IncludeCustomMetadata

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

Value

A list with the following syntax:

list(
  Metadata = list(
    Id = "string",
    CreatorId = "string",
    ParentFolderId = "string",
    CreatedTimestamp = as.POSIXct(
      "2015-01-01"
    ),
    ModifiedTimestamp = as.POSIXct(
      "2015-01-01"
    ),
    LatestVersionMetadata = 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"
      )
    ),
    ResourceState = "ACTIVE"|"RESTORING"|"RECYCLING"|"RECYCLED",
    Labels = list(
      "string"
    )
  ),
  CustomMetadata = list(
    "string"
  )
)

Request syntax

svc$get_document(
  AuthenticationToken = "string",
  DocumentId = "string",
  IncludeCustomMetadata = TRUE|FALSE
)