Spec-Zone.ru › AWS CLI v2

[ aws . iotsitewise ]

обновить-набор-данных

Описание

Обновляет набор данных.

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

Синтаксис

  update-dataset
--dataset-id <value>
--dataset-name <value>
[--dataset-description <value>]
--dataset-source <value>
[--client-token <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-id (строка)

Идентификатор набора данных.

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

Название набора данных.

--dataset-description (строка)

Описание набора данных и его функциональности.

--dataset-source (структура)

Источник данных для набора данных.

sourceType -> (строка)

Тип источника данных для набора данных.

sourceFormat -> (строка)

Формат источника данных, связанного с набором данных.

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

Подробности источника данных, связанного с набором данных.

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

Содержит сведения об источнике данных Kendra.

knowledgeBaseArn -> (строка)

Подробности источника данных Kendra.

roleArn -> (строка)

Подробности источника данных Kendra.

Сокращенный синтаксис:

sourceType=string,sourceFormat=string,sourceDetail={kendra={knowledgeBaseArn=string,roleArn=string}}

Синтаксис JSON:

{
  "sourceType": "KENDRA",
  "sourceFormat": "KNOWLEDGE_BASE",
  "sourceDetail": {
    "kendra": {
      "knowledgeBaseArn": "string",
      "roleArn": "string"
    }
  }
}

--client-token (строка)

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

--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
  • текст
  • таблица
  • 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.

Вывод

datasetId -> (строка)

Идентификатор набора данных.

datasetArn -> (строка)

ARN набора данных. Формат: arn:${Partition}:iotsitewise:${Region}:${Account}:dataset/${DatasetId}.

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

Состояние набора данных. Содержит состояние и любые сообщения об ошибках. Состояние является UPDATING после успешного вызова этого API и любых связанных сообщений об ошибках. Состояние является ACTIVE, когда готово к использованию.

state -> (строка)

Текущее состояние набора данных.

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

Содержит сведения об ошибке IoT SiteWise.

code -> (строка)

Код ошибки.

message -> (строка)

Сообщение об ошибке.

details -> (список)

Список подробных ошибок.

(структура)

Содержит подробную информацию об ошибке.

code -> (строка)

Код ошибки.

message -> (строка)

Сообщение об ошибке.

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

Spec-Zone.ru

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