Skip to content
AWS for Query.Farm

aws.comprehend.describe_dataset

Example SQL Queries

SELECT * FROM
aws.comprehend.describe_dataset
WHERE
"dataset_arn" = 'VALUE';

Description

Returns information about the dataset that you specify. For more information about datasets, see Flywheel overview in the Amazon Comprehend Developer Guide.

Table Definition

Column NameColumn Data Type
dataset_arn Required Input Column

The ARN of the dataset.

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
dataset_properties

The dataset properties.

STRUCT(
    "dataset_arn" VARCHAR,
    "dataset_name" VARCHAR,
    "dataset_type" VARCHAR,
    "dataset_s3_uri" VARCHAR,
    "description" VARCHAR,
    "status" VARCHAR,
    "message" VARCHAR,
    "number_of_documents" BIGINT,
    "creation_time" TIMESTAMP_S,
    "end_time" TIMESTAMP_S
)
Show child fields
dataset_properties.creation_time

Creation time of the dataset.

dataset_properties.dataset_arn

The ARN of the dataset.

dataset_properties.dataset_name

The name of the dataset.

dataset_properties.dataset_s3_uri

The S3 URI where the dataset is stored.

dataset_properties.dataset_type

The dataset type (training data or test data).

dataset_properties.description

Description of the dataset.

dataset_properties.end_time

Time when the data from the dataset becomes available in the data lake.

dataset_properties.message

A description of the status of the dataset.

dataset_properties.number_of_documents

The number of documents in the dataset.

dataset_properties.status

The dataset status. While the system creates the dataset, the status is CREATING. When the dataset is ready to use, the status changes to COMPLETED.