Get Folder

workdocs_get_folder

R Documentation

Retrieves the metadata of the specified folder

Description

Retrieves the metadata of the specified folder.

Usage

workdocs_get_folder(AuthenticationToken, FolderId,
  IncludeCustomMetadata)

Arguments

AuthenticationToken

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

FolderId

[required] The ID of the folder.

IncludeCustomMetadata

Set to TRUE to include custom metadata in the response.

Value

A list with the following syntax:

list(
  Metadata = list(
    Id = "string",
    Name = "string",
    CreatorId = "string",
    ParentFolderId = "string",
    CreatedTimestamp = as.POSIXct(
      "2015-01-01"
    ),
    ModifiedTimestamp = as.POSIXct(
      "2015-01-01"
    ),
    ResourceState = "ACTIVE"|"RESTORING"|"RECYCLING"|"RECYCLED",
    Signature = "string",
    Labels = list(
      "string"
    ),
    Size = 123,
    LatestVersionSize = 123
  ),
  CustomMetadata = list(
    "string"
  )
)

Request syntax

svc$get_folder(
  AuthenticationToken = "string",
  FolderId = "string",
  IncludeCustomMetadata = TRUE|FALSE
)