Spec-Zone.ru › AWS CLI v2

[ aws . timestream-write ]

write-records

Описание

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

Timestream поддерживает семантику чтения с конечной согласованностью. Это означает, что при запросе данных сразу после записи пакета данных в Timestream, результаты запроса могут не отражать результаты недавно завершённой операции записи. Результаты также могут включать некоторые устаревшие данные. Если вы повторите запрос запроса через короткий промежуток времени, результаты должны вернуть последние данные. Применяются квоты сервиса.

См. пример кода для получения подробностей.

Добавления (upsert)

Вы можете использовать параметр Version в запросе WriteRecords для обновления точек данных. Timestream отслеживает номер версии каждого записываемого элемента. Version по умолчанию равен 1, если он не указан для записываемого элемента в запросе. Timestream обновляет значение измерения существующего элемента вместе с его Version, когда получает запрос записи с более высоким номером Version для этого элемента. Если в запросе обновления значение измерения такое же, как у существующего элемента, Timestream всё равно обновляет Version, если оно больше, чем текущее значение Version. Вы можете обновлять точку данных столько раз, сколько нужно, при условии, что значение Version постоянно увеличивается.

Например, предположим, что вы записываете новый элемент, не указывая Version в запросе. Timestream сохраняет этот элемент и устанавливает Version в 1. Теперь предположим, что вы пытаетесь обновить этот элемент с запросом WriteRecords на тот же элемент с другим значением измерения, но, как и прежде, не предоставляя Version. В этом случае Timestream отклонит это обновление с RejectedRecordsException, так как версия обновлённого элемента не больше текущего значения Version.

Однако, если вы повторно отправите запрос об обновления с установленным Version равным 2, Timestream успешно обновит значение элемента, и Version будет установлено в 2. Далее предположим, что вы отправили запрос WriteRecords с тем же элементом и тем же значением измерения, но с Version, установленным в 3. В этом случае Timestream обновит только Version на 3. Любые дальнейшие обновления потребуют отправки номера версии, большего, чем 3, иначе запросы об обновлениях получат ответ RejectedRecordsException.

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

Синтаксис

  write-records
--database-name <value>
--table-name <value>
[--common-attributes <value>]
--records <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.

--common-attributes (структура)

Запись, содержащая общие атрибуты измерения, размерности, времени и версии, общие для всех записей в запросе. Указанные атрибуты измерения и размерности будут объединены с атрибутами измерения и размерности в объекте записей при записи данных в Timestream. Размерности не должны пересекаться, иначе будет выброшено исключение ValidationException. Другими словами, запись должна содержать размерности с уникальными именами.

Размерности -> (список)

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

(структура)

Представляет атрибуты метаданных временного ряда. Например, имя и зона доступности экземпляра EC2 или имя производителя ветряной турбины являются размерностями.

Имя -> (строка)

Размерность представляет атрибуты метаданных временного ряда. Например, имя и зона доступности экземпляра EC2 или имя производителя ветряной турбины являются размерностями.

Для ограничений на имена размерностей см. Ограничения на имена.

Значение -> (строка)

Значение размерности.

ТипЗначенияРазмерности -> (строка)

Тип данных размерности для точки данных временного ряда.

ИмяИзмерения -> (строка)

Измерение представляет атрибуты данных временного ряда. Например, использование ЦП экземпляра EC2 или обороты в минуту ветряной турбины являются измерениями.

ЗначениеИзмерения -> (строка)

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

ТипЗначенияИзмерения -> (строка)

Содержит тип данных значения измерения для точки данных временного ряда. По умолчанию тип - DOUBLE. Дополнительную информацию см. в разделе Типы данных.

Время -> (строка)

Содержит время, в которое было собрано значение измерения для точки данных. Значение времени плюс единица измерения представляют время, прошедшее с момента эпохи. Например, если значение времени равно 12345, а единица измерения равна ms, то с момента эпохи прошло 12345 ms.

ЕдиницаИзмеренияВремени -> (строка)

Разрешение единицы измерения временной метки. Указывает, является ли значение времени секундами, миллисекундами, наносекундами или другими поддерживаемыми значениями. По умолчанию MILLISECONDS.

Версия -> (длинное целое)

64-битный атрибут, используемый для обновлений записей. Запросы на запись дублируемых данных с более высоким номером версии обновят существующее значение измерения и версию. В случаях, когда значение измерения такое же, Version все равно будет обновлено. Значение по умолчанию - 1.

Примечание

Version должно быть 1 или больше, иначе вы получите ошибку ValidationException.

ЗначенияИзмерений -> (список)

Содержит список ЗначенийИзмерений для точек данных временных рядов.

Это разрешено только для типа MULTI. Для скалярных значений используйте атрибут MeasureValue записи напрямую.

(структура)

Представляет атрибут данных временного ряда. Например, использование ЦП экземпляра EC2 или обороты в минуту ветряной турбины являются измерениями. ЗначениеИзмерения имеет имя и значение.

ЗначениеИзмерения разрешено только для типа MULTI. Используя тип MULTI, вы можете передавать несколько атрибутов данных, связанных с одним временным рядом, в одной записи.

Имя -> (строка)

Имя значения измерения.

Для ограничений на имена ЗначенийИзмерений см. Ограничения на имена в руководстве разработчика Amazon Timestream.

Значение -> (строка)

Значение для значения измерения. Для получения информации см. Типы данных.

Тип -> (строка)

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

Краткий синтаксис:

Dimensions=[{Name=string,Value=string,DimensionValueType=string},{Name=string,Value=string,DimensionValueType=string}],MeasureName=string,MeasureValue=string,MeasureValueType=string,Time=string,TimeUnit=string,Version=long,MeasureValues=[{Name=string,Value=string,Type=string},{Name=string,Value=string,Type=string}]

Синтаксис JSON:

{
  "Dimensions": [
    {
      "Name": "string",
      "Value": "string",
      "DimensionValueType": "VARCHAR"
    }
    ...
  ],
  "MeasureName": "string",
  "MeasureValue": "string",
  "MeasureValueType": "DOUBLE"|"BIGINT"|"VARCHAR"|"BOOLEAN"|"TIMESTAMP"|"MULTI",
  "Time": "string",
  "TimeUnit": "MILLISECONDS"|"SECONDS"|"MICROSECONDS"|"NANOSECONDS",
  "Version": long,
  "MeasureValues": [
    {
      "Name": "string",
      "Value": "string",
      "Type": "DOUBLE"|"BIGINT"|"VARCHAR"|"BOOLEAN"|"TIMESTAMP"|"MULTI"
    }
    ...
  ]
}

--records (список)

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

(структура)

Представляет точку данных временного ряда, записываемую в Timestream. Каждая запись содержит массив размерностей. Размерности представляют атрибуты метаданных точки данных временного ряда, такие как имя экземпляра или зона доступности экземпляра EC2. Запись также содержит имя измерения, которое является именем собираемого измерения (например, использование ЦП экземпляра EC2). Кроме того, запись содержит значение измерения и тип значения, который является типом данных значения измерения. Также запись содержит временную метку, когда было собрано измерение, и единицу временной метки, которая представляет разрешение временной метки.

Записи имеют поле Version, которое является 64-битным long, которое вы можете использовать для обновления точек данных. Записи дублирующих записей с одинаковой размерностью, временной меткой и именем измерения, но с другим значением измерения будут успешны только в том случае, если атрибут Version записи в запросе записи больше, чем атрибут существующей записи. Timestream по умолчанию устанавливает значение Version в 1 для записей без поля Version.

Размерности -> (список)

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

(структура)

Представляет атрибуты метаданных временного ряда. Например, имя и зона доступности экземпляра EC2 или имя производителя ветряной турбины являются размерностями.

Имя -> (строка)

Размерность представляет атрибуты метаданных временного ряда. Например, имя и зона доступности экземпляра EC2 или имя производителя ветряной турбины являются размерностями.

Для ограничений на имена размерностей см. Ограничения на имена.

Значение -> (строка)

Значение размерности.

ТипЗначенияРазмерности -> (строка)

Тип данных размерности для точки данных временного ряда.

ИмяИзмерения -> (строка)

Измерение представляет атрибут данных временного ряда. Например, использование ЦП экземпляра EC2 или обороты в минуту ветряной турбины являются измерениями.

ЗначениеИзмерения -> (строка)

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

ТипЗначенияИзмерения -> (строка)

Содержит тип данных значения измерения для точки данных временного ряда. По умолчанию тип - DOUBLE. Дополнительную информацию см. в разделе Типы данных.

Время -> (строка)

Содержит время, в которое было собрано значение измерения для точки данных. Значение времени плюс единица измерения представляют время, прошедшее с момента эпохи. Например, если значение времени равно 12345, а единица измерения равна ms, то с момента эпохи прошло 12345 ms.

ЕдиницаИзмеренияВремени -> (строка)

Разрешение единицы измерения временной метки. Указывает, является ли значение времени секундами, миллисекундами, наносекундами или другими поддерживаемыми значениями. По умолчанию MILLISECONDS.

Версия -> (длинное целое)

64-битный атрибут, используемый для обновлений записей. Запросы на запись дублируемых данных с более высоким номером версии обновят существующее значение измерения и версию. В случаях, когда значение измерения такое же, Version все равно будет обновлено. Значение по умолчанию - 1.

Примечание

Version должно быть 1 или больше, иначе вы получите ошибку ValidationException.

ЗначенияИзмерений -> (список)

Содержит список ЗначенийИзмерений для точек данных временных рядов.

Это разрешено только для типа MULTI. Для скалярных значений используйте атрибут MeasureValue записи напрямую.

(структура)

Представляет атрибут данных временного ряда. Например, использование ЦП экземпляра EC2 или обороты в минуту ветряной турбины являются измерениями. ЗначениеИзмерения имеет имя и значение.

ЗначениеИзмерения разрешено только для типа MULTI. Используя тип MULTI, вы можете передавать несколько атрибутов данных, связанных с одним временным рядом, в одной записи.

Имя -> (строка)

Имя значения измерения.

Для ограничений на имена ЗначенийИзмерений см. Ограничения на имена в руководстве разработчика Amazon Timestream.

Значение -> (строка)

Значение для значения измерения. Для получения информации см. Типы данных.

Тип -> (строка)

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

Краткий синтаксис:

Dimensions=[{Name=string,Value=string,DimensionValueType=string},{Name=string,Value=string,DimensionValueType=string}],MeasureName=string,MeasureValue=string,MeasureValueType=string,Time=string,TimeUnit=string,Version=long,MeasureValues=[{Name=string,Value=string,Type=string},{Name=string,Value=string,Type=string}] ...

Синтаксис JSON:

[
  {
    "Dimensions": [
      {
        "Name": "string",
        "Value": "string",
        "DimensionValueType": "VARCHAR"
      }
      ...
    ],
    "MeasureName": "string",
    "MeasureValue": "string",
    "MeasureValueType": "DOUBLE"|"BIGINT"|"VARCHAR"|"BOOLEAN"|"TIMESTAMP"|"MULTI",
    "Time": "string",
    "TimeUnit": "MILLISECONDS"|"SECONDS"|"MICROSECONDS"|"NANOSECONDS",
    "Version": long,
    "MeasureValues": [
      {
        "Name": "string",
        "Value": "string",
        "Type": "DOUBLE"|"BIGINT"|"VARCHAR"|"BOOLEAN"|"TIMESTAMP"|"MULTI"
      }
      ...
    ]
  }
  ...
]

--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 (boolean)

Включить отладочную запись в журнал.

--endpoint-url (string)

Заменить стандартный URL команды на указанный.

--no-verify-ssl (boolean)

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

--no-paginate (boolean)

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

--output (string)

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

  • json
  • text
  • table
  • yaml
  • yaml-stream

--query (string)

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

--profile (string)

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

--region (string)

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

--version (string)

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

--color (string)

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

  • on
  • off
  • auto

--no-sign-request (boolean)

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

--ca-bundle (string)

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

--cli-read-timeout (int)

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

--cli-connect-timeout (int)

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

--cli-binary-format (string)

Стиль форматирования, используемый для двоичных блоков. По умолчанию используется формат 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 (boolean)

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

--cli-auto-prompt (boolean)

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

--no-cli-auto-prompt (boolean)

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

Вывод

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

Информация о записях, обработанных этим запросом.

Total -> (целое число)

Общее количество успешно обработанных записей.

MemoryStore -> (целое число)

Количество записей, обработанных в кэш-памяти.

MagneticStore -> (целое число)

Количество записей, обработанных в магнитном хранилище.

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

Spec-Zone.ru

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