aws.timestreamwrite.getTable

AWS v7.51.0, Oct 15 26

Viewing docs for AWS v7.51.0
published on Thursday, Oct 15, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-aws

Viewing docs for AWS v7.51.0
published on Thursday, Oct 15, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-aws

Example Usage

Basic Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const test = aws.timestreamwrite.getTable({
    databaseName: testAwsTimestreamwriteDatabase.databaseName,
    name: testAwsTimestreamwriteTable.tableName,
});

import pulumi
import pulumi_aws as aws

test = aws.timestreamwrite.get_table(database_name=test_aws_timestreamwrite_database["databaseName"],
    name=test_aws_timestreamwrite_table["tableName"])

package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/timestreamwrite"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := timestreamwrite.LookupTable(ctx, &timestreamwrite.LookupTableArgs{
			DatabaseName: testAwsTimestreamwriteDatabase.DatabaseName,
			Name:         testAwsTimestreamwriteTable.TableName,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var test = Aws.TimestreamWrite.GetTable.Invoke(new()
    {
        DatabaseName = testAwsTimestreamwriteDatabase.DatabaseName,
        Name = testAwsTimestreamwriteTable.TableName,
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.timestreamwrite.TimestreamwriteFunctions;
import com.pulumi.aws.timestreamwrite.inputs.GetTableArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var test = TimestreamwriteFunctions.getTable(GetTableArgs.builder()
            .databaseName(testAwsTimestreamwriteDatabase.databaseName())
            .name(testAwsTimestreamwriteTable.tableName())
            .build());

    }
}

variables:
  test:
    fn::invoke:
      function: aws:timestreamwrite:getTable
      arguments:
        databaseName: ${testAwsTimestreamwriteDatabase.databaseName}
        name: ${testAwsTimestreamwriteTable.tableName}

pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

data "aws_timestreamwrite_gettable" "test" {
  database_name = testAwsTimestreamwriteDatabase.databaseName
  name          = testAwsTimestreamwriteTable.tableName
}

Using getTable

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getTable(args: GetTableArgs, opts?: InvokeOptions): Promise<GetTableResult>
function getTableOutput(args: GetTableOutputArgs, opts?: InvokeOutputOptions): Output<GetTableResult>

def get_table(database_name: Optional[str] = None,
              name: Optional[str] = None,
              region: Optional[str] = None,
              opts: Optional[InvokeOptions] = None) -> GetTableResult
def get_table_output(database_name: pulumi.Input[Optional[str]] = None,
              name: pulumi.Input[Optional[str]] = None,
              region: pulumi.Input[Optional[str]] = None,
              opts: Optional[InvokeOutputOptions] = None) -> Output[GetTableResult]

func LookupTable(ctx *Context, args *LookupTableArgs, opts ...InvokeOption) (*LookupTableResult, error)
func LookupTableOutput(ctx *Context, args *LookupTableOutputArgs, opts ...InvokeOption) LookupTableResultOutput

> Note: This function is named LookupTable in the Go SDK.

public static class GetTable 
{
    public static Task<GetTableResult> InvokeAsync(GetTableArgs args, InvokeOptions? opts = null)
    public static Output<GetTableResult> Invoke(GetTableInvokeArgs args, InvokeOptions? opts = null)
    public static Output<GetTableResult> Invoke(GetTableInvokeArgs args, InvokeOutputOptions opts)
}

public static CompletableFuture<GetTableResult> getTable(GetTableArgs args, InvokeOptions options)
public static Output<GetTableResult> getTable(GetTableArgs args, InvokeOptions options)
public static Output<GetTableResult> getTable(GetTableArgs args, InvokeOutputOptions options)

fn::invoke:
  function: aws:timestreamwrite/getTable:getTable
  arguments:
    # arguments dictionary

data "aws_timestreamwrite_get_table" "name" {
    # arguments
}

The following arguments are supported:

DatabaseName string: Name of the Timestream database.
Name string: Name of the Timestream table.
Region string: Region where this resource will be managed. Defaults to the Region set in the provider configuration.

DatabaseName string: Name of the Timestream database.
Name string: Name of the Timestream table.
Region string: Region where this resource will be managed. Defaults to the Region set in the provider configuration.

database_name string: Name of the Timestream database.
name string: Name of the Timestream table.
region string: Region where this resource will be managed. Defaults to the Region set in the provider configuration.

databaseName String: Name of the Timestream database.
name String: Name of the Timestream table.
region String: Region where this resource will be managed. Defaults to the Region set in the provider configuration.

databaseName string: Name of the Timestream database.
name string: Name of the Timestream table.
region string: Region where this resource will be managed. Defaults to the Region set in the provider configuration.

database_name str: Name of the Timestream database.
name str: Name of the Timestream table.
region str: Region where this resource will be managed. Defaults to the Region set in the provider configuration.

databaseName String: Name of the Timestream database.
name String: Name of the Timestream table.
region String: Region where this resource will be managed. Defaults to the Region set in the provider configuration.

getTable Result

The following output properties are available:

Arn string: ARN that uniquely identifies the table.
CreationTime string: Time that table was created.
DatabaseName string: Name of database.
LastUpdatedTime string: Last time table was updated.
MagneticStoreWriteProperties List<GetTableMagneticStoreWriteProperty>: Object containing the following attributes to describe magnetic store writes.
Name string: Name of the timestream attribute used for a dimension key.
Region string
RetentionProperties List<GetTableRetentionProperty>: Object containing the following attributes to describe the retention duration for the memory and magnetic stores.
Schemas List<GetTableSchema>: Object containing the following attributes to describe the schema of the table.
TableStatus string: Current state of table.

Arn string: ARN that uniquely identifies the table.
CreationTime string: Time that table was created.
DatabaseName string: Name of database.
LastUpdatedTime string: Last time table was updated.
MagneticStoreWriteProperties []GetTableMagneticStoreWriteProperty: Object containing the following attributes to describe magnetic store writes.
Name string: Name of the timestream attribute used for a dimension key.
Region string
RetentionProperties []GetTableRetentionProperty: Object containing the following attributes to describe the retention duration for the memory and magnetic stores.
Schemas []GetTableSchema: Object containing the following attributes to describe the schema of the table.
TableStatus string: Current state of table.

arn string: ARN that uniquely identifies the table.
creation_time string: Time that table was created.
database_name string: Name of database.
last_updated_time string: Last time table was updated.
magnetic_store_write_properties list(object): Object containing the following attributes to describe magnetic store writes.
name string: Name of the timestream attribute used for a dimension key.
region string
retention_properties list(object): Object containing the following attributes to describe the retention duration for the memory and magnetic stores.
schemas list(object): Object containing the following attributes to describe the schema of the table.
table_status string: Current state of table.

arn String: ARN that uniquely identifies the table.
creationTime String: Time that table was created.
databaseName String: Name of database.
lastUpdatedTime String: Last time table was updated.
magneticStoreWriteProperties List<GetTableMagneticStoreWriteProperty>: Object containing the following attributes to describe magnetic store writes.
name String: Name of the timestream attribute used for a dimension key.
region String
retentionProperties List<GetTableRetentionProperty>: Object containing the following attributes to describe the retention duration for the memory and magnetic stores.
schemas List<GetTableSchema>: Object containing the following attributes to describe the schema of the table.
tableStatus String: Current state of table.

arn string: ARN that uniquely identifies the table.
creationTime string: Time that table was created.
databaseName string: Name of database.
lastUpdatedTime string: Last time table was updated.
magneticStoreWriteProperties GetTableMagneticStoreWriteProperty[]: Object containing the following attributes to describe magnetic store writes.
name string: Name of the timestream attribute used for a dimension key.
region string
retentionProperties GetTableRetentionProperty[]: Object containing the following attributes to describe the retention duration for the memory and magnetic stores.
schemas GetTableSchema[]: Object containing the following attributes to describe the schema of the table.
tableStatus string: Current state of table.

arn str: ARN that uniquely identifies the table.
creation_time str: Time that table was created.
database_name str: Name of database.
last_updated_time str: Last time table was updated.
magnetic_store_write_properties Sequence[GetTableMagneticStoreWriteProperty]: Object containing the following attributes to describe magnetic store writes.
name str: Name of the timestream attribute used for a dimension key.
region str
retention_properties Sequence[GetTableRetentionProperty]: Object containing the following attributes to describe the retention duration for the memory and magnetic stores.
schemas Sequence[GetTableSchema]: Object containing the following attributes to describe the schema of the table.
table_status str: Current state of table.

arn String: ARN that uniquely identifies the table.
creationTime String: Time that table was created.
databaseName String: Name of database.
lastUpdatedTime String: Last time table was updated.
magneticStoreWriteProperties List<Property Map>: Object containing the following attributes to describe magnetic store writes.
name String: Name of the timestream attribute used for a dimension key.
region String
retentionProperties List<Property Map>: Object containing the following attributes to describe the retention duration for the memory and magnetic stores.
schemas List<Property Map>: Object containing the following attributes to describe the schema of the table.
tableStatus String: Current state of table.

Supporting Types

GetTableMagneticStoreWriteProperty

EnableMagneticStoreWrites bool: Flag that is set based on if magnetic store writes are enabled.
MagneticStoreRejectedDataLocations List<GetTableMagneticStoreWritePropertyMagneticStoreRejectedDataLocation>: Object containing the following attributes to describe error reports for records rejected during magnetic store writes.

EnableMagneticStoreWrites bool: Flag that is set based on if magnetic store writes are enabled.
MagneticStoreRejectedDataLocations []GetTableMagneticStoreWritePropertyMagneticStoreRejectedDataLocation: Object containing the following attributes to describe error reports for records rejected during magnetic store writes.

enable_magnetic_store_writes bool: Flag that is set based on if magnetic store writes are enabled.
magnetic_store_rejected_data_locations list(object): Object containing the following attributes to describe error reports for records rejected during magnetic store writes.

enableMagneticStoreWrites Boolean: Flag that is set based on if magnetic store writes are enabled.
magneticStoreRejectedDataLocations List<GetTableMagneticStoreWritePropertyMagneticStoreRejectedDataLocation>: Object containing the following attributes to describe error reports for records rejected during magnetic store writes.

enableMagneticStoreWrites boolean: Flag that is set based on if magnetic store writes are enabled.
magneticStoreRejectedDataLocations GetTableMagneticStoreWritePropertyMagneticStoreRejectedDataLocation[]: Object containing the following attributes to describe error reports for records rejected during magnetic store writes.

enable_magnetic_store_writes bool: Flag that is set based on if magnetic store writes are enabled.
magnetic_store_rejected_data_locations Sequence[GetTableMagneticStoreWritePropertyMagneticStoreRejectedDataLocation]: Object containing the following attributes to describe error reports for records rejected during magnetic store writes.

enableMagneticStoreWrites Boolean: Flag that is set based on if magnetic store writes are enabled.
magneticStoreRejectedDataLocations List<Property Map>: Object containing the following attributes to describe error reports for records rejected during magnetic store writes.

GetTableMagneticStoreWritePropertyMagneticStoreRejectedDataLocation

S3Configurations List<GetTableMagneticStoreWritePropertyMagneticStoreRejectedDataLocationS3Configuration>: Object containing the following attributes to describe the configuration of an s3 location to write error reports for records rejected.

S3Configurations []GetTableMagneticStoreWritePropertyMagneticStoreRejectedDataLocationS3Configuration: Object containing the following attributes to describe the configuration of an s3 location to write error reports for records rejected.

s3_configurations list(object): Object containing the following attributes to describe the configuration of an s3 location to write error reports for records rejected.

s3Configurations List<GetTableMagneticStoreWritePropertyMagneticStoreRejectedDataLocationS3Configuration>: Object containing the following attributes to describe the configuration of an s3 location to write error reports for records rejected.

s3Configurations GetTableMagneticStoreWritePropertyMagneticStoreRejectedDataLocationS3Configuration[]: Object containing the following attributes to describe the configuration of an s3 location to write error reports for records rejected.

s3_configurations Sequence[GetTableMagneticStoreWritePropertyMagneticStoreRejectedDataLocationS3Configuration]: Object containing the following attributes to describe the configuration of an s3 location to write error reports for records rejected.

s3Configurations List<Property Map>: Object containing the following attributes to describe the configuration of an s3 location to write error reports for records rejected.

GetTableMagneticStoreWritePropertyMagneticStoreRejectedDataLocationS3Configuration

BucketName string: Name of S3 bucket.
EncryptionOption string: Encryption option for S3 location.
KmsKeyId string: AWS KMS key ID for S3 location with AWS managed key.
ObjectKeyPrefix string: Object key prefix for S3 location.

BucketName string: Name of S3 bucket.
EncryptionOption string: Encryption option for S3 location.
KmsKeyId string: AWS KMS key ID for S3 location with AWS managed key.
ObjectKeyPrefix string: Object key prefix for S3 location.

bucket_name string: Name of S3 bucket.
encryption_option string: Encryption option for S3 location.
kms_key_id string: AWS KMS key ID for S3 location with AWS managed key.
object_key_prefix string: Object key prefix for S3 location.

bucketName String: Name of S3 bucket.
encryptionOption String: Encryption option for S3 location.
kmsKeyId String: AWS KMS key ID for S3 location with AWS managed key.
objectKeyPrefix String: Object key prefix for S3 location.

bucketName string: Name of S3 bucket.
encryptionOption string: Encryption option for S3 location.
kmsKeyId string: AWS KMS key ID for S3 location with AWS managed key.
objectKeyPrefix string: Object key prefix for S3 location.

bucket_name str: Name of S3 bucket.
encryption_option str: Encryption option for S3 location.
kms_key_id str: AWS KMS key ID for S3 location with AWS managed key.
object_key_prefix str: Object key prefix for S3 location.

bucketName String: Name of S3 bucket.
encryptionOption String: Encryption option for S3 location.
kmsKeyId String: AWS KMS key ID for S3 location with AWS managed key.
objectKeyPrefix String: Object key prefix for S3 location.

GetTableRetentionProperty

MagneticStoreRetentionPeriodInDays int: Duration in days in which the data must be stored in magnetic store.
MemoryStoreRetentionPeriodInHours int: Duration in hours in which the data must be stored in memory store.

MagneticStoreRetentionPeriodInDays int: Duration in days in which the data must be stored in magnetic store.
MemoryStoreRetentionPeriodInHours int: Duration in hours in which the data must be stored in memory store.

magnetic_store_retention_period_in_days number: Duration in days in which the data must be stored in magnetic store.
memory_store_retention_period_in_hours number: Duration in hours in which the data must be stored in memory store.

magneticStoreRetentionPeriodInDays Integer: Duration in days in which the data must be stored in magnetic store.
memoryStoreRetentionPeriodInHours Integer: Duration in hours in which the data must be stored in memory store.

magneticStoreRetentionPeriodInDays number: Duration in days in which the data must be stored in magnetic store.
memoryStoreRetentionPeriodInHours number: Duration in hours in which the data must be stored in memory store.

magnetic_store_retention_period_in_days int: Duration in days in which the data must be stored in magnetic store.
memory_store_retention_period_in_hours int: Duration in hours in which the data must be stored in memory store.

magneticStoreRetentionPeriodInDays Number: Duration in days in which the data must be stored in magnetic store.
memoryStoreRetentionPeriodInHours Number: Duration in hours in which the data must be stored in memory store.

GetTableSchema

CompositePartitionKeys List<GetTableSchemaCompositePartitionKey>: Object containing the attributes to describe a composite partition key for the table.

CompositePartitionKeys []GetTableSchemaCompositePartitionKey: Object containing the attributes to describe a composite partition key for the table.

composite_partition_keys list(object): Object containing the attributes to describe a composite partition key for the table.

compositePartitionKeys List<GetTableSchemaCompositePartitionKey>: Object containing the attributes to describe a composite partition key for the table.

compositePartitionKeys GetTableSchemaCompositePartitionKey[]: Object containing the attributes to describe a composite partition key for the table.

composite_partition_keys Sequence[GetTableSchemaCompositePartitionKey]: Object containing the attributes to describe a composite partition key for the table.

compositePartitionKeys List<Property Map>: Object containing the attributes to describe a composite partition key for the table.

GetTableSchemaCompositePartitionKey

EnforcementInRecord string: Level of enforcement for the specification of a dimension key in ingested records.
Name string: Name of the Timestream table.
Type string: Type of partition key.

EnforcementInRecord string: Level of enforcement for the specification of a dimension key in ingested records.
Name string: Name of the Timestream table.
Type string: Type of partition key.

enforcement_in_record string: Level of enforcement for the specification of a dimension key in ingested records.
name string: Name of the Timestream table.
type string: Type of partition key.

enforcementInRecord String: Level of enforcement for the specification of a dimension key in ingested records.
name String: Name of the Timestream table.
type String: Type of partition key.

enforcementInRecord string: Level of enforcement for the specification of a dimension key in ingested records.
name string: Name of the Timestream table.
type string: Type of partition key.

enforcement_in_record str: Level of enforcement for the specification of a dimension key in ingested records.
name str: Name of the Timestream table.
type str: Type of partition key.

enforcementInRecord String: Level of enforcement for the specification of a dimension key in ingested records.
name String: Name of the Timestream table.
type String: Type of partition key.

Package Details

Repository: AWS Classic pulumi/pulumi-aws
License: Apache-2.0
Notes: This Pulumi package is based on the aws Terraform Provider.

Viewing docs for AWS v7.51.0
published on Thursday, Oct 15, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-aws

aws.timestreamwrite.getTable

On this page

On this page

Example Usage

Basic Usage

Using getTable

getTable Result

Supporting Types

GetTableMagneticStoreWriteProperty

GetTableMagneticStoreWritePropertyMagneticStoreRejectedDataLocation

GetTableMagneticStoreWritePropertyMagneticStoreRejectedDataLocationS3Configuration

GetTableRetentionProperty

GetTableSchema

GetTableSchemaCompositePartitionKey

Package Details

On this page

On this page

Try Pulumi Cloud free.
Your team will thank you.

aws.timestreamwrite.getTable

On this page

On this page

Example Usage

Basic Usage

Using getTable

getTable Result

Supporting Types

GetTableMagneticStoreWriteProperty

GetTableMagneticStoreWritePropertyMagneticStoreRejectedDataLocation

GetTableMagneticStoreWritePropertyMagneticStoreRejectedDataLocationS3Configuration

GetTableRetentionProperty

GetTableSchema

GetTableSchemaCompositePartitionKey

Package Details

On this page

On this page

Try Pulumi Cloud free.Your team will thank you.

Try Pulumi Cloud free.
Your team will thank you.