Skip to content

aws.workdocs.describe_folder_contents

Example SQL Queries

SELECT * FROM
aws.workdocs.describe_folder_contents
WHERE
"folder_id" = 'VALUE';

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.

Table Definition

Column NameColumn Data Type
folder_id Required Input Column

The ID of the folder.

VARCHAR
authentication_token Input Column

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

VARCHAR
include Input Column

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

VARCHAR
order Input Column

The order for the contents of the folder.

VARCHAR
sort Input Column

The sorting criteria.

VARCHAR
type Input Column

The type of items.

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
"type" VARCHAR,
"name" VARCHAR,
"account_id" VARCHAR,
"via_profile_name" VARCHAR,
"assumed_role_arn" VARCHAR,
"organization" STRUCT(
"account_name" VARCHAR,
"id" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[],
"master_account" STRUCT(
"id" VARCHAR,
"email" VARCHAR
),
"parents" STRUCT(
"type" VARCHAR,
"id" VARCHAR,
"name" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[]
)[]
)
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
documents

The documents in the specified folder.

STRUCT(
"id" VARCHAR,
"creator_id" VARCHAR,
"parent_folder_id" VARCHAR,
"created_timestamp" TIMESTAMP_S,
"modified_timestamp" TIMESTAMP_S,
"latest_version_metadata" STRUCT(
"id" VARCHAR,
"name" VARCHAR,
"content_type" VARCHAR,
"size" BIGINT,
"signature" VARCHAR,
"status" VARCHAR,
"created_timestamp" TIMESTAMP_S,
"modified_timestamp" TIMESTAMP_S,
"content_created_timestamp" TIMESTAMP_S,
"content_modified_timestamp" TIMESTAMP_S,
"creator_id" VARCHAR,
"thumbnail" MAP(VARCHAR, VARCHAR),
"source" MAP(VARCHAR, VARCHAR)
),
"resource_state" VARCHAR,
"labels" VARCHAR[]
)[]
Show child fields
documents[]
Show child fields
documents[].created_timestamp

The time when the document was created.

documents[].creator_id

The ID of the creator.

documents[].id

The ID of the document.

documents[].labels[]
documents[].latest_version_metadata

The latest version of the document.

Show child fields
documents[].latest_version_metadata.content_created_timestamp

The timestamp when the content of the document was originally created.

documents[].latest_version_metadata.content_modified_timestamp

The timestamp when the content of the document was modified.

documents[].latest_version_metadata.content_type

The content type of the document.

documents[].latest_version_metadata.created_timestamp

The timestamp when the document was first uploaded.

documents[].latest_version_metadata.creator_id

The ID of the creator.

documents[].latest_version_metadata.id

The ID of the version.

documents[].latest_version_metadata.modified_timestamp

The timestamp when the document was last uploaded.

documents[].latest_version_metadata.name

The name of the version.

documents[].latest_version_metadata.signature

The signature of the document.

documents[].latest_version_metadata.size

The size of the document, in bytes.

documents[].latest_version_metadata.source

The source of the document.

documents[].latest_version_metadata.status

The status of the document.

documents[].latest_version_metadata.thumbnail

The thumbnail of the document.

documents[].modified_timestamp

The time when the document was updated.

documents[].parent_folder_id

The ID of the parent folder.

documents[].resource_state

The resource state.

folders

The subfolders in the specified folder.

STRUCT(
"id" VARCHAR,
"name" VARCHAR,
"creator_id" VARCHAR,
"parent_folder_id" VARCHAR,
"created_timestamp" TIMESTAMP_S,
"modified_timestamp" TIMESTAMP_S,
"resource_state" VARCHAR,
"signature" VARCHAR,
"labels" VARCHAR[],
"size" BIGINT,
"latest_version_size" BIGINT
)[]
Show child fields
folders[]
Show child fields
folders[].created_timestamp

The time when the folder was created.

folders[].creator_id

The ID of the creator.

folders[].id

The ID of the folder.

folders[].labels[]
folders[].latest_version_size

The size of the latest version of the folder metadata.

folders[].modified_timestamp

The time when the folder was updated.

folders[].name

The name of the folder.

folders[].parent_folder_id

The ID of the parent folder.

folders[].resource_state

The resource state of the folder.

folders[].signature

The unique identifier created from the subfolders and documents of the folder.

folders[].size

The size of the folder metadata.