Skip to content
AWS for Query.Farm

aws.personalize.describe_dataset_group

Example SQL Queries

SELECT * FROM
aws.personalize.describe_dataset_group
WHERE
"dataset_group_arn" = 'VALUE';

Description

Describes the given dataset group. For more information on dataset groups, see CreateDatasetGroup.

Table Definition

Column NameColumn Data Type
dataset_group_arn Required Input Column

The Amazon Resource Name (ARN) of the dataset group 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_group

A listing of the dataset group's properties.

STRUCT(
    "name" VARCHAR,
    "dataset_group_arn" VARCHAR,
    "status" VARCHAR,
    "role_arn" VARCHAR,
    "kms_key_arn" VARCHAR,
    "creation_date_time" TIMESTAMP_S,
    "last_updated_date_time" TIMESTAMP_S,
    "failure_reason" VARCHAR,
    "domain" VARCHAR
)
Show child fields
dataset_group.creation_date_time

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

dataset_group.dataset_group_arn

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

dataset_group.domain

The domain of a Domain dataset group.

dataset_group.failure_reason

If creating a dataset group fails, provides the reason why.

dataset_group.kms_key_arn

The Amazon Resource Name (ARN) of the Key Management Service (KMS) key used to encrypt the datasets.

dataset_group.last_updated_date_time

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

dataset_group.name

The name of the dataset group.

dataset_group.role_arn

The ARN of the Identity and Access Management (IAM) role that has permissions to access the Key Management Service (KMS) key. Supplying an IAM role is only valid when also specifying a KMS key.

dataset_group.status

The current status of the dataset group.

A dataset group can be in one of the following states:

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

  • DELETE PENDING