Skip to content
AWS for Query.Farm

aws.iotanalytics.describe_datastore

Example SQL Queries

SELECT * FROM
aws.iotanalytics.describe_datastore
WHERE
"datastore_name" = 'VALUE';

Description

Retrieves information about a data store.

Table Definition

Column NameColumn Data Type
datastore_name Required Input Column

The name of the data store

VARCHAR
include_statistics Input Column

If true, additional statistical information about the data store is included in the response. This feature can't be used with a data store whose S3 storage is customer-managed.

BOOLEAN
_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
datastore

Information about the data store.

STRUCT(
    "name" VARCHAR,
    "storage" STRUCT(
        "service_managed_s3" BOOLEAN,
        "customer_managed_s3" STRUCT(
            "bucket" VARCHAR,
            "key_prefix" VARCHAR,
            "role_arn" VARCHAR
        ),
        "iot_site_wise_multi_layer_storage" STRUCT(
            "customer_managed_s3_storage" STRUCT(
                "bucket" VARCHAR,
                "key_prefix" VARCHAR
            )
        )
    ),
    "arn" VARCHAR,
    "status" VARCHAR,
    "retention_period" STRUCT(
        "unlimited" BOOLEAN,
        "number_of_days" BIGINT
    ),
    "creation_time" TIMESTAMP_S,
    "last_update_time" TIMESTAMP_S,
    "last_message_arrival_time" TIMESTAMP_S,
    "file_format_configuration" STRUCT(
        "json_configuration" BOOLEAN,
        "parquet_configuration" STRUCT(
            "schema_definition" STRUCT(
                "columns" STRUCT(
                    "name" VARCHAR,
                    "type" VARCHAR
                )[]
            )
        )
    ),
    "datastore_partitions" STRUCT(
        "partitions" STRUCT(
            "attribute_partition" STRUCT(
                "attribute_name" VARCHAR
            ),
            "timestamp_partition" STRUCT(
                "attribute_name" VARCHAR,
                "timestamp_format" VARCHAR
            )
        )[]
    )
)
Show child fields
datastore.arn

The ARN of the data store.

datastore.creation_time

When the data store was created.

datastore.datastore_partitions

Contains information about the partition dimensions in a data store.

Show child fields
datastore.datastore_partitions.partitions[]
Show child fields
datastore.datastore_partitions.partitions[].attribute_partition

A partition dimension defined by an attributeName.

Show child fields
datastore.datastore_partitions.partitions[].attribute_partition.attribute_name

The name of the attribute that defines a partition dimension.

datastore.datastore_partitions.partitions[].timestamp_partition

A partition dimension defined by a timestamp attribute.

Show child fields
datastore.datastore_partitions.partitions[].timestamp_partition.attribute_name

The attribute name of the partition defined by a timestamp.

datastore.datastore_partitions.partitions[].timestamp_partition.timestamp_format

The timestamp format of a partition defined by a timestamp. The default format is seconds since epoch (January 1, 1970 at midnight UTC time).

datastore.file_format_configuration

Contains the configuration information of file formats. IoT Analytics data stores support JSON and Parquet.

The default file format is JSON. You can specify only one format.

You can't change the file format after you create the data store.

Show child fields
datastore.file_format_configuration.json_configuration

Contains the configuration information of the JSON format.

datastore.file_format_configuration.parquet_configuration

Contains the configuration information of the Parquet format.

Show child fields
datastore.file_format_configuration.parquet_configuration.schema_definition

Information needed to define a schema.

Show child fields
datastore.file_format_configuration.parquet_configuration.schema_definition.columns[]
Show child fields
datastore.file_format_configuration.parquet_configuration.schema_definition.columns[].name

The name of the column.

datastore.file_format_configuration.parquet_configuration.schema_definition.columns[].type

The type of data. For more information about the supported data types, see Common data types in the Glue Developer Guide.

datastore.last_message_arrival_time

The last time when a new message arrived in the data store.

IoT Analytics updates this value at most once per minute for Amazon Simple Storage Service one data store. Hence, the lastMessageArrivalTime value is an approximation.

This feature only applies to messages that arrived in the data store after October 23, 2020.

datastore.last_update_time

The last time the data store was updated.

datastore.name

The name of the data store.

datastore.retention_period

How long, in days, message data is kept for the data store. When customerManagedS3 storage is selected, this parameter is ignored.

Show child fields
datastore.retention_period.number_of_days

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

datastore.retention_period.unlimited

If true, message data is kept indefinitely.

datastore.status

The status of a data store:

CREATING

The data store is being created.

ACTIVE

The data store has been created and can be used.

DELETING

The data store is being deleted.

datastore.storage

Where data in a data store is stored.. You can choose serviceManagedS3 storage, customerManagedS3 storage, or iotSiteWiseMultiLayerStorage storage. The default is serviceManagedS3. You can't change the choice of Amazon S3 storage after your data store is created.

Show child fields
datastore.storage.customer_managed_s3

S3-customer-managed; When you choose customer-managed storage, the retentionPeriod parameter is ignored. You can't change the choice of Amazon S3 storage after your data store is created.

Show child fields
datastore.storage.customer_managed_s3.bucket

The name of the Amazon S3 bucket where your data is stored.

datastore.storage.customer_managed_s3.key_prefix

(Optional) The prefix used to create the keys of the data store data objects. Each object in an Amazon S3 bucket has a key that is its unique identifier in the bucket. Each object in a bucket has exactly one key. The prefix must end with a forward slash (/).

datastore.storage.customer_managed_s3.role_arn

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

datastore.storage.iot_site_wise_multi_layer_storage

Used to store data used by IoT SiteWise in an Amazon S3 bucket that you manage. You can't change the choice of Amazon S3 storage after your data store is created.

Show child fields
datastore.storage.iot_site_wise_multi_layer_storage.customer_managed_s3_storage

Used to store data used by IoT SiteWise in an Amazon S3 bucket that you manage.

Show child fields
datastore.storage.iot_site_wise_multi_layer_storage.customer_managed_s3_storage.bucket

The name of the Amazon S3 bucket where your data is stored.

datastore.storage.iot_site_wise_multi_layer_storage.customer_managed_s3_storage.key_prefix

(Optional) The prefix used to create the keys of the data store data objects. Each object in an Amazon S3 bucket has a key that is its unique identifier in the bucket. Each object in a bucket has exactly one key. The prefix must end with a forward slash (/).

datastore.storage.service_managed_s3

Used to store data in an Amazon S3 bucket managed by IoT Analytics. You can't change the choice of Amazon S3 storage after your data store is created.

statistics

Additional statistical information about the data store. Included if the includeStatistics parameter is set to true in the request.

STRUCT(
    "size" STRUCT(
        "estimated_size_in_bytes" DOUBLE,
        "estimated_on" TIMESTAMP_S
    )
)
Show child fields
statistics.size

The estimated size of the data store.

Show child fields
statistics.size.estimated_on

The time when the estimate of the size of the resource was made.

statistics.size.estimated_size_in_bytes

The estimated size of the resource, in bytes.