TimestreamWrite / Client / describe_table

describe_table

TimestreamWrite.Client.describe_table(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.describe_table(
    DatabaseName='string',
    TableName='string'
)

Parameters:

• DatabaseName (string) –

  [REQUIRED]

  The name of the Timestream database.

• TableName (string) –

  [REQUIRED]

  The name of the Timestream table.

Return type:

dict

Returns:

Response Syntax

{
    'Table': {
        'Arn': 'string',
        'TableName': 'string',
        'DatabaseName': 'string',
        'TableStatus': 'ACTIVE'|'DELETING'|'RESTORING',
        'RetentionProperties': {
            'MemoryStoreRetentionPeriodInHours': 123,
            'MagneticStoreRetentionPeriodInDays': 123
        },
        'CreationTime': datetime(2015, 1, 1),
        'LastUpdatedTime': datetime(2015, 1, 1),
        'MagneticStoreWriteProperties': {
            'EnableMagneticStoreWrites': True|False,
            'MagneticStoreRejectedDataLocation': {
                'S3Configuration': {
                    'BucketName': 'string',
                    'ObjectKeyPrefix': 'string',
                    'EncryptionOption': 'SSE_S3'|'SSE_KMS',
                    'KmsKeyId': 'string'
                }
            }
        },
        'Schema': {
            'CompositePartitionKey': [
                {
                    'Type': 'DIMENSION'|'MEASURE',
                    'Name': 'string',
                    'EnforcementInRecord': 'REQUIRED'|'OPTIONAL'
                },
            ]
        }
    }
}

Response Structure

• (dict) –

  • Table (dict) –

    The Timestream table.

    • Arn (string) –

      The Amazon Resource Name that uniquely identifies this table.

    • TableName (string) –

      The name of the Timestream table.

    • DatabaseName (string) –

      The name of the Timestream database that contains this table.

    • TableStatus (string) –

      The current state of the table:

      • DELETING - The table is being deleted.

      • ACTIVE - The table is ready for use.

    • RetentionProperties (dict) –

      The retention duration for the memory store and magnetic store.

      • MemoryStoreRetentionPeriodInHours (integer) –

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

      • MagneticStoreRetentionPeriodInDays (integer) –

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

    • CreationTime (datetime) –

      The time when the Timestream table was created.

    • LastUpdatedTime (datetime) –

      The time when the Timestream table was last updated.

    • MagneticStoreWriteProperties (dict) –

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

      • EnableMagneticStoreWrites (boolean) –

        A flag to enable magnetic store writes.

      • MagneticStoreRejectedDataLocation (dict) –

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

        • S3Configuration (dict) –

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

          • BucketName (string) –

            The bucket name of the customer S3 bucket.

          • ObjectKeyPrefix (string) –

            The object key preview for the customer S3 location.

          • EncryptionOption (string) –

            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.

          • KmsKeyId (string) –

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

    • Schema (dict) –

      The schema of the table.

      • CompositePartitionKey (list) –

        A non-empty list of partition keys defining the attributes used to partition the table data. The order of the list determines the partition hierarchy. The name and type of each partition key as well as the partition key order cannot be changed after the table is created. However, the enforcement level of each partition key can be changed.

        • (dict) –

          An attribute used in partitioning data in a table. A dimension key partitions data using the values of the dimension specified by the dimension-name as partition key, while a measure key partitions data using measure names (values of the ‘measure_name’ column).

          • Type (string) –

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

          • Name (string) –

            The name of the attribute used for a dimension key.

          • EnforcementInRecord (string) –

            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).

Exceptions

• TimestreamWrite.Client.exceptions.ResourceNotFoundException

• TimestreamWrite.Client.exceptions.ValidationException

• TimestreamWrite.Client.exceptions.AccessDeniedException

• TimestreamWrite.Client.exceptions.ThrottlingException

• TimestreamWrite.Client.exceptions.InternalServerException

• TimestreamWrite.Client.exceptions.InvalidEndpointException