Skip to content

aws.iotanalytics.describe_dataset

Example SQL Queries

SELECT * FROM
aws.iotanalytics.describe_dataset
WHERE
"dataset_name" = 'VALUE';

Description

Retrieves information about a dataset.

Table Definition

Column NameColumn Data Type
dataset_name Required Input Column

The name of the dataset whose information is retrieved.

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

An object that contains information about the dataset.

STRUCT(
"name" VARCHAR,
"arn" VARCHAR,
"actions" STRUCT(
"action_name" VARCHAR,
"query_action" STRUCT(
"sql_query" VARCHAR,
"filters" STRUCT(
"delta_time" STRUCT(
"offset_seconds" BIGINT,
"time_expression" VARCHAR
)
)[]
),
"container_action" STRUCT(
"image" VARCHAR,
"execution_role_arn" VARCHAR,
"resource_configuration" STRUCT(
"compute_type" VARCHAR,
"volume_size_in_gb" BIGINT
),
"variables" STRUCT(
"name" VARCHAR,
"string_value" VARCHAR,
"double_value" DOUBLE,
"dataset_content_version_value" STRUCT(
"dataset_name" VARCHAR
),
"output_file_uri_value" STRUCT(
"file_name" VARCHAR
)
)[]
)
)[],
"triggers" STRUCT(
"schedule" STRUCT(
"expression" VARCHAR
),
"dataset" STRUCT(
"name" VARCHAR
)
)[],
"content_delivery_rules" STRUCT(
"entry_name" VARCHAR,
"destination" STRUCT(
"iot_events_destination_configuration" STRUCT(
"input_name" VARCHAR,
"role_arn" VARCHAR
),
"s3_destination_configuration" STRUCT(
"bucket" VARCHAR,
"key" VARCHAR,
"glue_configuration" STRUCT(
"table_name" VARCHAR,
"database_name" VARCHAR
),
"role_arn" VARCHAR
)
)
)[],
"status" VARCHAR,
"creation_time" TIMESTAMP_S,
"last_update_time" TIMESTAMP_S,
"retention_period" STRUCT(
"unlimited" BOOLEAN,
"number_of_days" BIGINT
),
"versioning_configuration" STRUCT(
"unlimited" BOOLEAN,
"max_versions" BIGINT
),
"late_data_rules" STRUCT(
"rule_name" VARCHAR,
"rule_configuration" STRUCT(
"delta_time_session_window_configuration" STRUCT(
"timeout_in_minutes" BIGINT
)
)
)[]
)
Show child fields
dataset.actions[]
Show child fields
dataset.actions[].action_name

The name of the dataset action by which dataset contents are automatically created.

dataset.actions[].container_action

Information that allows the system to run a containerized application to create the dataset contents. The application must be in a Docker container along with any required support libraries.

Show child fields
dataset.actions[].container_action.execution_role_arn

The ARN of the role that gives permission to the system to access required resources to run the containerAction. This includes, at minimum, permission to retrieve the dataset contents that are the input to the containerized application.

dataset.actions[].container_action.image

The ARN of the Docker container stored in your account. The Docker container contains an application and required support libraries and is used to generate dataset contents.

dataset.actions[].container_action.resource_configuration

Configuration of the resource that executes the containerAction.

Show child fields
dataset.actions[].container_action.resource_configuration.compute_type

The type of the compute resource used to execute the containerAction. Possible values are: ACU_1 (vCPU=4, memory=16 GiB) or ACU_2 (vCPU=8, memory=32 GiB).

dataset.actions[].container_action.resource_configuration.volume_size_in_gb

The size, in GB, of the persistent storage available to the resource instance used to execute the containerAction (min: 1, max: 50).

dataset.actions[].container_action.variables[]
Show child fields
dataset.actions[].container_action.variables[].dataset_content_version_value

The value of the variable as a structure that specifies a dataset content version.

Show child fields
dataset.actions[].container_action.variables[].dataset_content_version_value.dataset_name

The name of the dataset whose latest contents are used as input to the notebook or application.

dataset.actions[].container_action.variables[].double_value

The value of the variable as a double (numeric).

dataset.actions[].container_action.variables[].name

The name of the variable.

dataset.actions[].container_action.variables[].output_file_uri_value

The value of the variable as a structure that specifies an output file URI.

Show child fields
dataset.actions[].container_action.variables[].output_file_uri_value.file_name

The URI of the location where dataset contents are stored, usually the URI of a file in an S3 bucket.

dataset.actions[].container_action.variables[].string_value

The value of the variable as a string.

dataset.actions[].query_action

An SqlQueryDatasetAction object that uses an SQL query to automatically create dataset contents.

Show child fields
dataset.actions[].query_action.filters[]
Show child fields
dataset.actions[].query_action.filters[].delta_time

Used to limit data to that which has arrived since the last execution of the action.

Show child fields
dataset.actions[].query_action.filters[].delta_time.offset_seconds

The number of seconds of estimated in-flight lag time of message data. When you create dataset contents using message data from a specified timeframe, some message data might still be in flight when processing begins, and so do not arrive in time to be processed. Use this field to make allowances for the in flight time of your message data, so that data not processed from a previous timeframe is included with the next timeframe. Otherwise, missed message data would be excluded from processing during the next timeframe too, because its timestamp places it within the previous timeframe.

dataset.actions[].query_action.filters[].delta_time.time_expression

An expression by which the time of the message data might be determined. This can be the name of a timestamp field or a SQL expression that is used to derive the time the message data was generated.

dataset.actions[].query_action.sql_query

A SQL query string.

dataset.arn

The ARN of the dataset.

dataset.content_delivery_rules[]
Show child fields
dataset.content_delivery_rules[].destination

The destination to which dataset contents are delivered.

Show child fields
dataset.content_delivery_rules[].destination.iot_events_destination_configuration

Configuration information for delivery of dataset contents to IoT Events.

Show child fields
dataset.content_delivery_rules[].destination.iot_events_destination_configuration.input_name

The name of the IoT Events input to which dataset contents are delivered.

dataset.content_delivery_rules[].destination.iot_events_destination_configuration.role_arn

The ARN of the role that grants IoT Analytics permission to deliver dataset contents to an IoT Events input.

dataset.content_delivery_rules[].destination.s3_destination_configuration

Configuration information for delivery of dataset contents to Amazon S3.

Show child fields
dataset.content_delivery_rules[].destination.s3_destination_configuration.bucket

The name of the S3 bucket to which dataset contents are delivered.

dataset.content_delivery_rules[].destination.s3_destination_configuration.glue_configuration

Configuration information for coordination with Glue, a fully managed extract, transform and load (ETL) service.

Show child fields
dataset.content_delivery_rules[].destination.s3_destination_configuration.glue_configuration.database_name

The name of the database in your Glue Data Catalog in which the table is located. An Glue Data Catalog database contains metadata tables.

dataset.content_delivery_rules[].destination.s3_destination_configuration.glue_configuration.table_name

The name of the table in your Glue Data Catalog that is used to perform the ETL operations. An Glue Data Catalog table contains partitioned data and descriptions of data sources and targets.

dataset.content_delivery_rules[].destination.s3_destination_configuration.key

The key of the dataset contents object in an S3 bucket. Each object has a key that is a unique identifier. Each object has exactly one key.

You can create a unique key with the following options:

  • Use !{iotanalytics:scheduleTime} to insert the time of a scheduled SQL query run.

  • Use !{iotanalytics:versionId} to insert a unique hash that identifies a dataset content.

  • Use !{iotanalytics:creationTime} to insert the creation time of a dataset content.

The following example creates a unique key for a CSV file: dataset/mydataset/!{iotanalytics:scheduleTime}/!{iotanalytics:versionId}.csv

If you don't use !{iotanalytics:versionId} to specify the key, you might get duplicate keys. For example, you might have two dataset contents with the same scheduleTime but different versionIds. This means that one dataset content overwrites the other.

dataset.content_delivery_rules[].destination.s3_destination_configuration.role_arn

The ARN of the role that grants IoT Analytics permission to interact with your Amazon S3 and Glue resources.

dataset.content_delivery_rules[].entry_name

The name of the dataset content delivery rules entry.

dataset.creation_time

When the dataset was created.

dataset.last_update_time

The last time the dataset was updated.

dataset.late_data_rules[]
Show child fields
dataset.late_data_rules[].rule_configuration

The information needed to configure the late data rule.

Show child fields
dataset.late_data_rules[].rule_configuration.delta_time_session_window_configuration

The information needed to configure a delta time session window.

Show child fields
dataset.late_data_rules[].rule_configuration.delta_time_session_window_configuration.timeout_in_minutes

A time interval. You can use timeoutInMinutes so that IoT Analytics can batch up late data notifications that have been generated since the last execution. IoT Analytics sends one batch of notifications to Amazon CloudWatch Events at one time.

For more information about how to write a timestamp expression, see Date and Time Functions and Operators, in the Presto 0.172 Documentation.

dataset.late_data_rules[].rule_name

The name of the late data rule.

dataset.name

The name of the dataset.

dataset.retention_period

Optional. How long, in days, message data is kept for the dataset.

Show child fields
dataset.retention_period.number_of_days

The number of days that message data is kept. The unlimited parameter must be false.

dataset.retention_period.unlimited

If true, message data is kept indefinitely.

dataset.status

The status of the dataset.

dataset.triggers[]
Show child fields
dataset.triggers[].dataset

The dataset whose content creation triggers the creation of this dataset's contents.

Show child fields
dataset.triggers[].dataset.name

The name of the dataset whose content generation triggers the new dataset content generation.

dataset.triggers[].schedule

The Schedule when the trigger is initiated.

Show child fields
dataset.triggers[].schedule.expression

The expression that defines when to trigger an update. For more information, see Schedule Expressions for Rules in the Amazon CloudWatch Events User Guide.

dataset.versioning_configuration

Optional. How many versions of dataset contents are kept. If not specified or set to null, only the latest version plus the latest succeeded version (if they are different) are kept for the time period specified by the retentionPeriod parameter. For more information, see Keeping Multiple Versions of IoT Analytics datasets in the IoT Analytics User Guide.

Show child fields
dataset.versioning_configuration.max_versions

How many versions of dataset contents are kept. The unlimited parameter must be false.

dataset.versioning_configuration.unlimited

If true, unlimited versions of dataset contents are kept.