list_tables

list_tables(**kwargs)

Provides a list of tables, along with the name, status, and retention properties of each table. See code sample for details.

See also: AWS API Documentation

Request Syntax

response = client.list_tables(
    DatabaseName='string',
    NextToken='string',
    MaxResults=123
)
Parameters
  • DatabaseName (string) -- The name of the Timestream database.
  • NextToken (string) -- The pagination token. To resume pagination, provide the NextToken value as argument of a subsequent API invocation.
  • MaxResults (integer) -- The total number of items to return in the output. If the total number of items available is more than the value specified, a NextToken is provided in the output. To resume pagination, provide the NextToken value as argument of a subsequent API invocation.
Return type

dict

Returns

Response Syntax

{
    'Tables': [
        {
            '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'
                    }
                }
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • Tables (list) --

      A list of tables.

      • (dict) --

        Represents a database table in Timestream. Tables contain one or more related time series. You can modify the retention duration of the memory store and the magnetic store for a 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.

    • NextToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previously truncated response.

Exceptions

  • TimestreamWrite.Client.exceptions.InternalServerException
  • TimestreamWrite.Client.exceptions.ThrottlingException
  • TimestreamWrite.Client.exceptions.ValidationException
  • TimestreamWrite.Client.exceptions.ResourceNotFoundException
  • TimestreamWrite.Client.exceptions.AccessDeniedException
  • TimestreamWrite.Client.exceptions.InvalidEndpointException