Describes the contents of the specified folder, including its documents and subfolders¶

Description¶

Describes the contents of the specified folder, including its documents and subfolders.

By default, Amazon WorkDocs returns the first 100 active document and folder metadata items. If there are more results, the response includes a marker that you can use to request the next set of results. You can also request initialized documents.

Usage¶

workdocs_describe_folder_contents(AuthenticationToken, FolderId, Sort,
  Order, Limit, Marker, Type, Include)

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.
Sort

The sorting criteria.
Order

The order for the contents of the folder.
Limit

The maximum number of items to return with this call.
Marker

The marker for the next set of results. This marker was received from a previous call.
Type

The type of items.
Include

The contents to include. Specify "INITIALIZED" to include initialized documents.

Value¶

A list with the following syntax:

list(
  Folders = list(
    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
    )
  ),
  Documents = list(
    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"
      )
    )
  ),
  Marker = "string"
)

Request syntax¶

svc$describe_folder_contents(
  AuthenticationToken = "string",
  FolderId = "string",
  Sort = "DATE"|"NAME",
  Order = "ASCENDING"|"DESCENDING",
  Limit = 123,
  Marker = "string",
  Type = "ALL"|"DOCUMENT"|"FOLDER",
  Include = "string"
)