Skip to content
AWS for Query.Farm

aws.workdocs.get_folder

Example SQL Queries

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

Description

Retrieves the metadata of the specified folder.

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_custom_metadata Input Column

Set to TRUE to include custom metadata in the response.

BOOLEAN
_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
custom_metadata

The custom metadata on the folder.

MAP(VARCHAR, VARCHAR)
metadata

The metadata of the 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
metadata.created_timestamp

The time when the folder was created.

metadata.creator_id

The ID of the creator.

metadata.id

The ID of the folder.

metadata.labels[]
metadata.latest_version_size

The size of the latest version of the folder metadata.

metadata.modified_timestamp

The time when the folder was updated.

metadata.name

The name of the folder.

metadata.parent_folder_id

The ID of the parent folder.

metadata.resource_state

The resource state of the folder.

metadata.signature

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

metadata.size

The size of the folder metadata.