Spec-Zone.ru › AWS CLI v2

[ aws . iotsitewise ]

создание-набора-данных

Описание

Создаёт набор данных для подключения внешнего источника данных.

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

Синтаксис

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

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

--tags (карта)

Список пар ключ-значение, содержащих метаданные для политики доступа. Дополнительные сведения см. в разделе «Использование тегов для ресурсов IoT SiteWise» в руководстве пользователя IoT SiteWise.

key -> (строка)

value -> (строка)

Краткая форма:

KeyName1=string,KeyName2=string

Синтаксис JSON:

{"string": "string"
  ...}

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

Статус набора данных. Содержит состояние и любые сообщения об ошибках. Состояние — CREATING после успешного вызова 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