Skip to content
AWS for Query.Farm

aws.rekognition.describe_dataset

Example SQL Queries

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

Description

This operation applies only to Amazon Rekognition Custom Labels.

Describes an Amazon Rekognition Custom Labels dataset. You can get information such as the current status of a dataset and statistics about the images and labels in a dataset.

This operation requires permissions to perform the rekognition:DescribeDataset action.

Table Definition

Column NameColumn Data Type
dataset_arn Required Input Column

The Amazon Resource Name (ARN) of the dataset that you want 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_description

The description for the dataset. 

STRUCT(
    "creation_timestamp" TIMESTAMP_S,
    "last_updated_timestamp" TIMESTAMP_S,
    "status" VARCHAR,
    "status_message" VARCHAR,
    "status_message_code" VARCHAR,
    "dataset_stats" STRUCT(
        "labeled_entries" BIGINT,
        "total_entries" BIGINT,
        "total_labels" BIGINT,
        "error_entries" BIGINT
    )
)
Show child fields
dataset_description.creation_timestamp

The Unix timestamp for the time and date that the dataset was created.

dataset_description.dataset_stats

The status message code for the dataset.

Show child fields
dataset_description.dataset_stats.error_entries

The total number of entries that contain at least one error.

dataset_description.dataset_stats.labeled_entries

The total number of images in the dataset that have labels.

dataset_description.dataset_stats.total_entries

The total number of images in the dataset.

dataset_description.dataset_stats.total_labels

The total number of labels declared in the dataset.

dataset_description.last_updated_timestamp

The Unix timestamp for the date and time that the dataset was last updated.

dataset_description.status

The status of the dataset.

dataset_description.status_message

The status message for the dataset.

dataset_description.status_message_code

The status message code for the dataset operation. If a service error occurs, try the API call again later. If a client error occurs, check the input parameters to the dataset API call that failed.