Spec-Zone.ru › AWS CLI v2

[ aws . timestream-write ]

describe-table

Описание

Возвращает информацию о таблице, включая имя таблицы, имя базы данных, срок хранения в кэше памяти и на магнитном носителе. Применяются квоты сервиса. Подробности см. в примере кода.

См. также: AWS API документация

Синтаксис

  describe-table
--database-name <value>
--table-name <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Параметры

--database-name (строка)

Имя базы данных Timestream.

--table-name (строка)

Имя таблицы Timestream.

--cli-input-json | --cli-input-yaml (строка) Считывает аргументы из предоставленной JSON-строки. JSON-строка соответствует формату, предоставленному в --generate-cli-skeleton. Если другие аргументы предоставлены в командной строке, эти значения переопределят значения, предоставленные JSON. Невозможно передавать произвольные двоичные значения, используя значение, предоставленное в JSON, так как строка будет взята буквально. Это не может быть указано вместе с --cli-input-yaml.

--generate-cli-skeleton (строка) Выводит JSON-скелет в стандартный вывод без отправки запроса к API. Если предоставлено значение без значения или со значением input, выводит пример входного JSON, который можно использовать как аргумент для --cli-input-json. Аналогично, если предоставлено значение yaml-input, будет выведен пример входного YAML, который можно использовать с --cli-input-yaml. Если предоставлено значение output, оно проверяет входные данные команды и возвращает пример выходного JSON для этой команды. Сгенерированный JSON-скелет не является стабильным между версиями AWS CLI, и нет гарантий обратной совместимости в сгенерированном JSON-скелете.

Глобальные параметры

--debug (логическое значение)

Включить отладку.

--endpoint-url (строка)

Переопределить URL по умолчанию команды заданным URL.

--no-verify-ssl (логическое значение)

По умолчанию AWS CLI использует SSL при взаимодействии с AWS-сервисами. Для каждого SSL-соединения AWS CLI будет проверять SSL-сертификаты. Этот параметр переопределяет поведение проверки SSL-сертификатов по умолчанию.

--no-paginate (логическое значение)

Отключить автоматическую постраничную навигацию. Если автоматическая постраничная навигация отключена, AWS CLI выполнит только один вызов для первой страницы результатов.

--output (строка)

Стиль форматирования для вывода команды.

  • json
  • text
  • таблица
  • yaml
  • yaml-поток

--query (строка)

Запрос JMESPath для фильтрации данных ответа.

--profile (строка)

Использовать определённый профиль из файла ваших учетных данных.

--region (строка)

Регион для использования. Переопределяет настройки конфигурации/среды.

--version (строка)

Отобразить версию этого инструмента.

--color (строка)

Включить/выключить цветной вывод.

  • включить
  • выключить
  • автоматически

--no-sign-request (логическое значение)

Не подписывать запросы. Учетные данные не будут загружены, если этот параметр предоставлен.

--ca-bundle (строка)

Файл сертификатов CA для проверки SSL-сертификатов. Переопределяет настройки конфигурации/среды.

--cli-read-timeout (целое число)

Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет выполняться блокирующим образом и не будет иметь таймаута. Значение по умолчанию составляет 60 секунд.

--cli-connect-timeout (целое число)

Максимальное время подключения сокета в секундах. Если значение установлено в 0, подключение сокета будет выполняться блокирующим образом и не будет иметь таймаута. Значение по умолчанию составляет 60 секунд.

--cli-binary-format (строка)

Стиль форматирования, используемый для двоичных блоков. Формат по умолчанию — base64. Формат base64 ожидает, что двоичные блоки будут предоставлены как строка, закодированная в base64. Формат raw-in-base64-out сохраняет совместимость с поведением AWS CLI V1, и двоичные значения должны передаваться буквально. При предоставлении содержимого из файла, которое соответствует двоичному блоку, fileb:// всегда будет обрабатываться как двоичный и будет использовать содержимое файла непосредственно независимо от параметра cli-binary-format. При использовании file:// содержимое файла должно быть должным образом отформатировано для настроенного cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (логическое значение)

Отключить пейджер CLI для вывода.

--cli-auto-prompt (логическое значение)

Автоматически запросить параметры ввода CLI.

--no-cli-auto-prompt (логическое значение)

Отключить автоматический запрос параметров ввода CLI.

Вывод

Таблица -> (структура)

Таблица Timestream.

Arn -> (строка)

Уникальный Amazon Resource Name этой таблицы.

TableName -> (строка)

Имя таблицы Timestream.

DatabaseName -> (строка)

Имя базы данных Timestream, содержащей эту таблицу.

TableStatus -> (строка)

Текущее состояние таблицы:

  • DELETING - Таблица удаляется.
  • ACTIVE - Таблица готова к использованию.

RetentionProperties -> (структура)

Срок хранения для кэша памяти и магнитного носителя.

MemoryStoreRetentionPeriodInHours -> (длинное целое число)

Срок, в течение которого данные должны храниться в кэше памяти.

MagneticStoreRetentionPeriodInDays -> (длинное целое число)

Срок, в течение которого данные должны храниться на магнитном носителе.

CreationTime -> (отметка времени)

Время создания таблицы Timestream.

LastUpdatedTime -> (отметка времени)

Время последнего обновления таблицы Timestream.

MagneticStoreWriteProperties -> (структура)

Содержит свойства для настройки таблицы при включении записи на магнитном носителе.

EnableMagneticStoreWrites -> (логическое значение)

Флаг для включения записи на магнитном носителе.

MagneticStoreRejectedDataLocation -> (структура)

Место расположения отчетов об ошибках для записей, отклоненных асинхронно во время записи на магнитном носителе.

S3Configuration -> (структура)

Настройка расположения в S3 для записи отчетов об ошибках для записей, отклоненных асинхронно, во время записи на магнитном носителе.

BucketName -> (строка)

Имя ведра клиентского S3.

ObjectKeyPrefix -> (строка)

Префикс ключа объекта для клиентского расположения S3.

EncryptionOption -> (строка)

Параметр шифрования для клиентского расположения S3. Параметры — серверное шифрование S3 с управляемым ключом S3 или управляемым ключом Amazon Web Services.

KmsKeyId -> (строка)

Идентификатор ключа KMS для клиентского расположения S3 при шифровании с помощью управляемого ключа Amazon Web Services.

Schema -> (структура)

Схема таблицы.

CompositePartitionKey -> (список)

Непустой список ключевых партиций, определяющих атрибуты, используемые для разделения данных таблицы. Порядок списка определяет иерархию партиций. Имя и тип каждой ключевой партиции, а также порядок ключевой партиции не могут быть изменены после создания таблицы. Однако уровень принуждения каждой ключевой партиции может быть изменен.

(структура)

Атрибут, используемый для разделения данных в таблице. Ключ измерения разделяет данные, используя значения, указанные именем измерения в качестве ключа партиции, а ключ измерения разделяет данные, используя имена мер (значения столбца «measure_name»).

Type -> (строка)

Тип ключевой партиции. Варианты — ИЗМЕРЕНИЕ (ключ измерения) и МЕРА (ключ измерения).

Name -> (строка)

Имя атрибута, используемого для ключа измерения.

EnforcementInRecord -> (строка)

Уровень принуждения к указанию ключа измерения в записях, вводимых в таблицу. Параметры — ОБЯЗАТЕЛЬНО (ключ измерения должен быть указан) и НЕОБЯЗАТЕЛЬНО (ключ измерения не обязательно указывать).

© Copyright 2025, Amazon Web Services. Created using Sphinx.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API