Skip to content
AWS for Query.Farm

aws.personalize.describe_dataset

Example SQL Queries

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

Description

Describes the given dataset. For more information on datasets, see CreateDataset.

Table Definition

Column NameColumn Data Type
dataset_arn Required Input Column

The Amazon Resource Name (ARN) of the dataset to describe.

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

A listing of the dataset's properties.

STRUCT(
    "name" VARCHAR,
    "dataset_arn" VARCHAR,
    "dataset_group_arn" VARCHAR,
    "dataset_type" VARCHAR,
    "schema_arn" VARCHAR,
    "status" VARCHAR,
    "creation_date_time" TIMESTAMP_S,
    "last_updated_date_time" TIMESTAMP_S,
    "latest_dataset_update" STRUCT(
        "schema_arn" VARCHAR,
        "status" VARCHAR,
        "failure_reason" VARCHAR,
        "creation_date_time" TIMESTAMP_S,
        "last_updated_date_time" TIMESTAMP_S
    ),
    "tracking_id" VARCHAR
)
Show child fields
dataset.creation_date_time

The creation date and time (in Unix time) of the dataset.

dataset.dataset_arn

The Amazon Resource Name (ARN) of the dataset that you want metadata for.

dataset.dataset_group_arn

The Amazon Resource Name (ARN) of the dataset group.

dataset.dataset_type

One of the following values:

  • Interactions

  • Items

  • Users

  • Actions

  • Action_Interactions

dataset.last_updated_date_time

A time stamp that shows when the dataset was updated.

dataset.latest_dataset_update

Describes the latest update to the dataset.

Show child fields
dataset.latest_dataset_update.creation_date_time

The creation date and time (in Unix time) of the dataset update.

dataset.latest_dataset_update.failure_reason

If updating a dataset fails, provides the reason why.

dataset.latest_dataset_update.last_updated_date_time

The last update date and time (in Unix time) of the dataset.

dataset.latest_dataset_update.schema_arn

The Amazon Resource Name (ARN) of the schema that replaced the previous schema of the dataset.

dataset.latest_dataset_update.status

The status of the dataset update.

dataset.name

The name of the dataset.

dataset.schema_arn

The ARN of the associated schema.

dataset.status

The status of the dataset.

A dataset can be in one of the following states:

  • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

  • DELETE PENDING > DELETE IN_PROGRESS

dataset.tracking_id

The ID of the event tracker for an Action interactions dataset. You specify the tracker's ID in the PutActionInteractions API operation. Amazon Personalize uses it to direct new data to the Action interactions dataset in your dataset group.