Skip to content
AWS for Query.Farm

aws.timestream_write.describe_table

Example SQL Queries

SELECT * FROM
aws.timestream_write.describe_table
WHERE
"database_name" = 'VALUE'
AND "table_name" = 'VALUE';

Description

Returns information about the table, including the table name, database name, retention duration of the memory store and the magnetic store. Service quotas apply. See code sample for details.

Table Definition

Column NameColumn Data Type
database_name Required Input Column

The name of the Timestream database.

VARCHAR
table_name Required Input Column

The name of the Timestream table.

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.

table

The Timestream table.

STRUCT(
    "arn" VARCHAR,
    "table_name" VARCHAR,
    "database_name" VARCHAR,
    "table_status" VARCHAR,
    "retention_properties" STRUCT(
        "memory_store_retention_period_in_hours" BIGINT,
        "magnetic_store_retention_period_in_days" BIGINT
    ),
    "creation_time" TIMESTAMP_S,
    "last_updated_time" TIMESTAMP_S,
    "magnetic_store_write_properties" STRUCT(
        "enable_magnetic_store_writes" BOOLEAN,
        "magnetic_store_rejected_data_location" STRUCT(
            "s3_configuration" STRUCT(
                "bucket_name" VARCHAR,
                "object_key_prefix" VARCHAR,
                "encryption_option" VARCHAR,
                "kms_key_id" VARCHAR
            )
        )
    ),
    "schema" STRUCT(
        "composite_partition_key" STRUCT(
            "type" VARCHAR,
            "name" VARCHAR,
            "enforcement_in_record" VARCHAR
        )[]
    )
)
Show child fields
table.arn

The Amazon Resource Name that uniquely identifies this table.

table.creation_time

The time when the Timestream table was created.

table.database_name

The name of the Timestream database that contains this table.

table.last_updated_time

The time when the Timestream table was last updated.

table.magnetic_store_write_properties

Contains properties to set on the table when enabling magnetic store writes.

Show child fields
table.magnetic_store_write_properties.enable_magnetic_store_writes

A flag to enable magnetic store writes.

table.magnetic_store_write_properties.magnetic_store_rejected_data_location

The location to write error reports for records rejected asynchronously during magnetic store writes.

Show child fields
table.magnetic_store_write_properties.magnetic_store_rejected_data_location.s3_configuration

Configuration of an S3 location to write error reports for records rejected, asynchronously, during magnetic store writes.

Show child fields
table.magnetic_store_write_properties.magnetic_store_rejected_data_location.s3_configuration.bucket_name

The bucket name of the customer S3 bucket.

table.magnetic_store_write_properties.magnetic_store_rejected_data_location.s3_configuration.encryption_option

The encryption option for the customer S3 location. Options are S3 server-side encryption with an S3 managed key or Amazon Web Services managed key.

table.magnetic_store_write_properties.magnetic_store_rejected_data_location.s3_configuration.kms_key_id

The KMS key ID for the customer S3 location when encrypting with an Amazon Web Services managed key.

table.magnetic_store_write_properties.magnetic_store_rejected_data_location.s3_configuration.object_key_prefix

The object key preview for the customer S3 location.

table.retention_properties

The retention duration for the memory store and magnetic store.

Show child fields
table.retention_properties.magnetic_store_retention_period_in_days

The duration for which data must be stored in the magnetic store.

table.retention_properties.memory_store_retention_period_in_hours

The duration for which data must be stored in the memory store.

table.schema

The schema of the table.

Show child fields
table.schema.composite_partition_key[]
Show child fields
table.schema.composite_partition_key[].enforcement_in_record

The level of enforcement for the specification of a dimension key in ingested records. Options are REQUIRED (dimension key must be specified) and OPTIONAL (dimension key does not have to be specified).

table.schema.composite_partition_key[].name

The name of the attribute used for a dimension key.

table.schema.composite_partition_key[].type

The type of the partition key. Options are DIMENSION (dimension key) and MEASURE (measure key).

table.table_name

The name of the Timestream table.

table.table_status

The current state of the table:

  • DELETING - The table is being deleted.

  • ACTIVE - The table is ready for use.