[ aws . iotanalytics ]
обновление-набора-данных
Описание
Обновляет настройки набора данных.
См. также: Документация API AWS
Синтаксис
update-dataset
--dataset-name <value>
--actions <value>
[--triggers <value>]
[--content-delivery-rules <value>]
[--retention-period <value>]
[--versioning-configuration <value>]
[--late-data-rules <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]
Параметры
--dataset-name (строка)
--actions (список)
Список объектов DatasetAction.
(структура)
Объект DatasetAction, который определяет, как автоматически создаётся содержимое набора данных.
actionName -> (строка)
queryAction -> (структура)
Объект SqlQueryDatasetAction, использующий SQL-запрос для автоматического создания содержимого набора данных.
sqlQuery -> (строка)
filters -> (список)
Предфильтры, применяемые к данным сообщений.
(структура)
Информация, используемая для фильтрации данных сообщений, чтобы разделить их в соответствии со временным интервалом их прибытия.
deltaTime -> (структура)
Используется для ограничения данных только теми, которые поступили после последнего выполнения действия.
offsetSeconds -> (целое число)
timeExpression -> (строка)
containerAction -> (структура)
Информация, которая позволяет системе запускать контейнерное приложение для создания содержимого набора данных. Приложение должно быть в контейнере Docker вместе со всеми необходимыми вспомогательными библиотеками.
image -> (строка)
executionRoleArn -> (строка)
containerAction . В него, как минимум, входит разрешение на получение содержимого набора данных, являющегося входом в контейнерное приложение.resourceConfiguration -> (структура)
Настройки ресурса, который выполняет containerAction .
computeType -> (строка)
containerAction . Возможные значения: ACU_1 (vCPU=4, память=16 ГБ) или ACU_2 (vCPU=8, память=32 ГБ).volumeSizeInGB -> (целое число)
containerAction (мин: 1, макс: 50).variables -> (список)
Значения переменных, используемых в контексте выполнения контейнерного приложения (в основном, параметры, передаваемые приложению). Каждая переменная должна иметь имя и значение, заданное одним из stringValue , datasetContentVersionValue или outputFileUriValue .
(структура)
Экземпляр переменной, который будет передан в выполнение containerAction . Каждая переменная должна иметь имя и значение, заданное одним из stringValue , datasetContentVersionValue или outputFileUriValue .
name -> (строка)
stringValue -> (строка)
doubleValue -> (двойное)
datasetContentVersionValue -> (структура)
Значение переменной как структура, которая определяет версию содержимого набора данных.
datasetName -> (строка)
outputFileUriValue -> (структура)
Значение переменной как структура, которая определяет URI выходного файла.
fileName -> (строка)
Синтаксис JSON:
[
{
"actionName": "string",
"queryAction": {
"sqlQuery": "string",
"filters": [
{
"deltaTime": {
"offsetSeconds": integer,
"timeExpression": "string"
}
}
...
]
},
"containerAction": {
"image": "string",
"executionRoleArn": "string",
"resourceConfiguration": {
"computeType": "ACU_1"|"ACU_2",
"volumeSizeInGB": integer
},
"variables": [
{
"name": "string",
"stringValue": "string",
"doubleValue": double,
"datasetContentVersionValue": {
"datasetName": "string"
},
"outputFileUriValue": {
"fileName": "string"
}
}
...
]
}
}
...
]
--triggers (список)
Список объектов DatasetTrigger. Список может быть пустым или содержать до пяти объектов DatasetTrigger.
(структура)
DatasetTrigger, который определяет, когда набор данных обновляется автоматически.
schedule -> (структура)
Расписание, когда запускается триггер.
expression -> (строка)
dataset -> (структура)
Набор данных, создание содержимого которого запускает создание содержимого этого набора данных.
name -> (строка)
Краткая форма синтаксиса:
schedule={expression=string},dataset={name=string} ...
Синтаксис JSON:
[
{
"schedule": {
"expression": "string"
},
"dataset": {
"name": "string"
}
}
...
]
--content-delivery-rules (список)
При создании содержимого набора данных оно доставляется в указанные здесь пункты назначения.
(структура)
При создании содержимого набора данных оно доставляется в указанный пункт назначения.
entryName -> (строка)
destination -> (структура)
Пункт назначения, в который доставляется содержимое набора данных.
iotEventsDestinationConfiguration -> (структура)
Конфигурационная информация для доставки содержимого набора данных в IoT Events.
inputName -> (строка)
roleArn -> (строка)
s3DestinationConfiguration -> (структура)
Конфигурационная информация для доставки содержимого набора данных в Amazon S3.
bucket -> (строка)
key -> (строка)
Ключ объекта содержимого набора данных в ведре S3. Каждый объект имеет ключ, который является уникальным идентификатором. Каждый объект имеет ровно один ключ.
Вы можете создать уникальный ключ, используя следующие параметры:
- Используйте
!{iotanalytics:scheduleTime}, чтобы вставить время выполнения запланированного SQL-запроса. - Используйте
!{iotanalytics:versionId}, чтобы вставить уникальный хеш, который идентифицирует содержимое набора данных. - Используйте
!{iotanalytics:creationTime}, чтобы вставить время создания содержимого набора данных.
Следующий пример создаёт уникальный ключ для файла CSV: dataset/mydataset/!{iotanalytics:scheduleTime}/!{iotanalytics:versionId}.csv
Примечание
Если вы не используете!{iotanalytics:versionId} для указания ключа, вы можете получить дублирующиеся ключи. Например, у вас могут быть два содержимых набора данных с одинаковым scheduleTime, но разными versionId.glueConfiguration -> (структура)
Конфигурационная информация для координации с Glue, полностью управляемой службой ETL (извлечения, преобразования и загрузки).
tableName -> (строка)
databaseName -> (строка)
roleArn -> (строка)
Синтаксис JSON:
[
{
"entryName": "string",
"destination": {
"iotEventsDestinationConfiguration": {
"inputName": "string",
"roleArn": "string"
},
"s3DestinationConfiguration": {
"bucket": "string",
"key": "string",
"glueConfiguration": {
"tableName": "string",
"databaseName": "string"
},
"roleArn": "string"
}
}
}
...
]
--retention-period (структура)
Сколько дней содержимое набора данных хранится для набора данных.
unlimited -> (булево)
numberOfDays -> (целое число)
unlimited должен быть false.Краткая форма синтаксиса:
unlimited=boolean,numberOfDays=integer
Синтаксис JSON:
{
"unlimited": true|false,
"numberOfDays": integer
}
--versioning-configuration (структура)
Необязательно. Сколько версий содержимого набора данных хранится. Если не указано или установлено в null, только последняя версия плюс последняя успешная версия (если они отличаются) хранятся в течение периода, указанного параметром retentionPeriod. Дополнительную информацию см. в разделе «Сохранение нескольких версий наборов данных IoT Analytics» в Руководстве пользователя IoT Analytics.
unlimited -> (булево)
maxVersions -> (целое число)
unlimited должен быть false.Краткая форма синтаксиса:
unlimited=boolean,maxVersions=integer
Синтаксис JSON:
{
"unlimited": true|false,
"maxVersions": integer
}
--late-data-rules (список)
Список правил данных, которые отправляют уведомления в CloudWatch, когда данные приходят с опозданием. Для указания lateDataRules набор данных должен использовать фильтр DeltaTimer.
(структура)
Структура, содержащая имя и конфигурационную информацию правила опоздания данных.
ruleName -> (строка)
ruleConfiguration -> (структура)
Информация, необходимая для настройки правила опоздания данных.
deltaTimeSessionWindowConfiguration -> (структура)
Информация, необходимая для настройки окна сессии delta time.
timeoutInMinutes -> (целое число)
Временной интервал. Вы можете использовать timeoutInMinutes, чтобы IoT Analytics мог объединять уведомления об опоздании данных, сгенерированные с момента последнего выполнения. IoT Analytics отправляет одну партию уведомлений в Amazon CloudWatch Events одновременно.
Дополнительную информацию о написании выражения отметки времени см. в разделе «Функции и операторы дат и времени» в документации Presto 0.172.
Краткая форма синтаксиса:
ruleName=string,ruleConfiguration={deltaTimeSessionWindowConfiguration={timeoutInMinutes=integer}} ...
Синтаксис JSON:
[
{
"ruleName": "string",
"ruleConfiguration": {
"deltaTimeSessionWindowConfiguration": {
"timeoutInMinutes": integer
}
}
}
...
]
--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.
Примеры
Примечание
Для использования следующих примеров необходимо установить и настроить AWS CLI. Подробную информацию см. в руководстве «Начало работы» в руководстве пользователя AWS CLI.
Если не указано иное, все примеры используют правила цитирования в стиле Unix. Эти примеры необходимо адаптировать к правилам цитирования вашей консоли. Дополнительную информацию см. в разделе «Использование кавычек со строками» в руководстве пользователя AWS CLI.
Для обновления набора данных
Следующий update-dataset пример изменяет настройки указанного набора данных.
aws iotanalytics update-dataset \
--cli-input-json file://update-dataset.json
Содержимое update-dataset.json:
{
"datasetName": "mydataset",
"actions": [
{
"actionName": "myDatasetUpdateAction",
"queryAction": {
"sqlQuery": "SELECT * FROM mydatastore"
}
}
],
"retentionPeriod": {
"numberOfDays": 92
}
}
Эта команда не выводит ничего.
Дополнительную информацию см. в `UpdateDataset <https://docs.aws.amazon.com/iotanalytics/latest/APIReference/API_UpdateDataset.html >`__ в справке по API AWS IoT Analytics.
Вывод
Нет
© Copyright 2025, Amazon Web Services. Created using Sphinx.