[ aws . timestream-write ]

describe-database

Description

Returns information about the database, including the database name, time that the database was created, and the total number of tables found within the database. Service quotas apply. For more information, see Access Management in the Timestream Developer Guide.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  describe-database
--database-name <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--database-name (string)

The name of the Timestream database.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Output

Database -> (structure)

The name of the Timestream table.

Arn -> (string)

The Amazon Resource Name that uniquely identifies this database.

DatabaseName -> (string)

The name of the Timestream database.

TableCount -> (long)

The total number of tables found within a Timestream database.

KmsKeyId -> (string)

The identifier of the KMS key used to encrypt the data stored in the database.

CreationTime -> (timestamp)

The time when the database was created, calculated from the Unix epoch time.

LastUpdatedTime -> (timestamp)

The last time that this database was updated.