Skip to content
AWS for Query.Farm

aws.keyspaces.get_table

Example SQL Queries

SELECT * FROM
aws.keyspaces.get_table
WHERE
"keyspace_name" = 'VALUE'
AND "table_name" = 'VALUE';

Description

Returns information about the table, including the table's name and current status, the keyspace name, configuration settings, and metadata.

To read table metadata using GetTable, Select action permissions for the table and system tables are required to complete the operation.

Table Definition

Column NameColumn Data Type
keyspace_name Required Input Column

The name of the keyspace that the specified table is stored in.

VARCHAR
table_name Required Input Column

The name of the specified 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.

capacity_specification

The read/write throughput capacity mode for a table. The options are:

  • throughputMode:PAY_PER_REQUEST

  • throughputMode:PROVISIONED 

STRUCT(
    "throughput_mode" VARCHAR,
    "read_capacity_units" BIGINT,
    "write_capacity_units" BIGINT,
    "last_update_to_pay_per_request_timestamp" TIMESTAMP_S
)
Show child fields
capacity_specification.last_update_to_pay_per_request_timestamp

The timestamp of the last operation that changed the provisioned throughput capacity of a table.

capacity_specification.read_capacity_units

The throughput capacity specified for read operations defined in read capacity units (RCUs).

capacity_specification.throughput_mode

The read/write throughput capacity mode for a table. The options are:

  • throughputMode:PAY_PER_REQUEST and

  • throughputMode:PROVISIONED - Provisioned capacity mode requires readCapacityUnits and writeCapacityUnits as input.

The default is throughput_mode:PAY_PER_REQUEST.

For more information, see Read/write capacity modes in the Amazon Keyspaces Developer Guide.

capacity_specification.write_capacity_units

The throughput capacity specified for write operations defined in write capacity units (WCUs).

client_side_timestamps

The client-side timestamps setting of the table.

STRUCT(
    "status" VARCHAR
)
Show child fields
client_side_timestamps.status

Shows how to enable client-side timestamps settings for the specified table.

comment

The the description of the specified table.

STRUCT(
    "message" VARCHAR
)
Show child fields
comment.message

An optional description of the table.

creation_timestamp

The creation timestamp of the specified table.

TIMESTAMP_S
default_time_to_live

The default Time to Live settings in seconds of the specified table.

BIGINT
encryption_specification

The encryption settings of the specified table.

STRUCT(
    "type" VARCHAR,
    "kms_key_identifier" VARCHAR
)
Show child fields
encryption_specification.kms_key_identifier

The Amazon Resource Name (ARN) of the customer managed KMS key, for example kms_key_identifier:ARN.

encryption_specification.type

The encryption option specified for the table. You can choose one of the following KMS keys (KMS keys):

  • type:AWS_OWNED_KMS_KEY - This key is owned by Amazon Keyspaces.

  • type:CUSTOMER_MANAGED_KMS_KEY - This key is stored in your account and is created, owned, and managed by you. This option requires the kms_key_identifier of the KMS key in Amazon Resource Name (ARN) format as input.

The default is type:AWS_OWNED_KMS_KEY.

For more information, see Encryption at rest in the Amazon Keyspaces Developer Guide.

point_in_time_recovery

The point-in-time recovery status of the specified table.

STRUCT(
    "status" VARCHAR,
    "earliest_restorable_timestamp" TIMESTAMP_S
)
Show child fields
point_in_time_recovery.earliest_restorable_timestamp

Specifies the earliest possible restore point of the table in ISO 8601 format.

point_in_time_recovery.status

Shows if point-in-time recovery is enabled or disabled for the specified table.

replica_specifications

Returns the Amazon Web Services Region specific settings of all Regions a multi-Region table is replicated in.

STRUCT(
    "region" VARCHAR,
    "status" VARCHAR,
    "capacity_specification" STRUCT(
        "throughput_mode" VARCHAR,
        "read_capacity_units" BIGINT,
        "write_capacity_units" BIGINT,
        "last_update_to_pay_per_request_timestamp" TIMESTAMP_S
    )
)[]
Show child fields
replica_specifications[]
Show child fields
replica_specifications[].capacity_specification

The read/write throughput capacity mode for a table. The options are:

  • throughputMode:PAY_PER_REQUEST and

  • throughputMode:PROVISIONED.

For more information, see Read/write capacity modes in the Amazon Keyspaces Developer Guide.

Show child fields
replica_specifications[].capacity_specification.last_update_to_pay_per_request_timestamp

The timestamp of the last operation that changed the provisioned throughput capacity of a table.

replica_specifications[].capacity_specification.read_capacity_units

The throughput capacity specified for read operations defined in read capacity units (RCUs).

replica_specifications[].capacity_specification.throughput_mode

The read/write throughput capacity mode for a table. The options are:

  • throughputMode:PAY_PER_REQUEST and

  • throughputMode:PROVISIONED - Provisioned capacity mode requires readCapacityUnits and writeCapacityUnits as input.

The default is throughput_mode:PAY_PER_REQUEST.

For more information, see Read/write capacity modes in the Amazon Keyspaces Developer Guide.

replica_specifications[].capacity_specification.write_capacity_units

The throughput capacity specified for write operations defined in write capacity units (WCUs).

replica_specifications[].region

The Amazon Web Services Region.

replica_specifications[].status

The status of the multi-Region table in the specified Amazon Web Services Region.

resource_arn

The Amazon Resource Name (ARN) of the specified table.

VARCHAR
schema_definition

The schema definition of the specified table.

STRUCT(
    "all_columns" STRUCT(
        "name" VARCHAR,
        "type" VARCHAR
    )[],
    "partition_keys" STRUCT(
        "name" VARCHAR
    )[],
    "clustering_keys" STRUCT(
        "name" VARCHAR,
        "order_by" VARCHAR
    )[],
    "static_columns" STRUCT(
        "name" VARCHAR
    )[]
)
Show child fields
schema_definition.all_columns[]
Show child fields
schema_definition.all_columns[].name

The name of the column.

schema_definition.all_columns[].type

The data type of the column. For a list of available data types, see Data types in the Amazon Keyspaces Developer Guide.

schema_definition.clustering_keys[]
Show child fields
schema_definition.clustering_keys[].name

The name(s) of the clustering column(s).

schema_definition.clustering_keys[].order_by

Sets the ascendant (ASC) or descendant (DESC) order modifier.

schema_definition.partition_keys[]
Show child fields
schema_definition.partition_keys[].name

The name(s) of the partition key column(s).

schema_definition.static_columns[]
Show child fields
schema_definition.static_columns[].name

The name of the static column.

status

The current status of the specified table.

VARCHAR
ttl

The custom Time to Live settings of the specified table.

STRUCT(
    "status" VARCHAR
)
Show child fields
ttl.status

Shows how to enable custom Time to Live (TTL) settings for the specified table.