Skip to content
AWS for Query.Farm

aws.workdocs.get_document

Example SQL Queries

SELECT * FROM
aws.workdocs.get_document
WHERE
"document_id" = 'VALUE';

Description

Retrieves details of a document.

Table Definition

Column NameColumn Data Type
document_id Required Input Column

The ID of the document.

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 this 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 document.

MAP(VARCHAR, VARCHAR)
metadata

The metadata details of the document.

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
metadata.created_timestamp

The time when the document was created.

metadata.creator_id

The ID of the creator.

metadata.id

The ID of the document.

metadata.labels[]
metadata.latest_version_metadata

The latest version of the document.

Show child fields
metadata.latest_version_metadata.content_created_timestamp

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

metadata.latest_version_metadata.content_modified_timestamp

The timestamp when the content of the document was modified.

metadata.latest_version_metadata.content_type

The content type of the document.

metadata.latest_version_metadata.created_timestamp

The timestamp when the document was first uploaded.

metadata.latest_version_metadata.creator_id

The ID of the creator.

metadata.latest_version_metadata.id

The ID of the version.

metadata.latest_version_metadata.modified_timestamp

The timestamp when the document was last uploaded.

metadata.latest_version_metadata.name

The name of the version.

metadata.latest_version_metadata.signature

The signature of the document.

metadata.latest_version_metadata.size

The size of the document, in bytes.

metadata.latest_version_metadata.source

The source of the document.

metadata.latest_version_metadata.status

The status of the document.

metadata.latest_version_metadata.thumbnail

The thumbnail of the document.

metadata.modified_timestamp

The time when the document was updated.

metadata.parent_folder_id

The ID of the parent folder.

metadata.resource_state

The resource state.