[ aws . iotfleetwise ]
get-campaign
Описание
Получает информацию о кампании.
Предупреждение
Доступ к определенным функциям Amazon Web Services IoT FleetWise в настоящее время ограничен. Для получения дополнительной информации см. Доступность регионов и функций Amazon Web Services в руководстве разработчика Amazon Web Services IoT FleetWise.См. также: Документацию API AWS
Синтаксис
get-campaign
--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]
Параметры
--name (строка)
--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.
Вывод
name -> (строка)
arn -> (строка)
description -> (строка)
signalCatalogArn -> (строка)
targetArn -> (строка)
status -> (строка)
CREATING , WAITING_FOR_APPROVAL , RUNNING , и SUSPENDED .startTime -> (метка времени)
expiryTime -> (метка времени)
postTriggerCollectionDuration -> (целое число)
diagnosticsMode -> (строка)
spoolingMode -> (строка)
compression -> (строка)
OFF, сигналы не сжимаются. Если не указано, используется SNAPPY.priority -> (целое число)
signalsToCollect -> (список)
Информация о списке сигналов для сбора данных.
(структура)
Информация о сигнале.
name -> (строка)
maxSampleCount -> (целое число)
minimumSamplingIntervalMs -> (целое число)
Минимальная продолжительность времени (в миллисекундах) между двумя триггерными событиями для сбора данных.
Примечание
Если сигнал часто меняется, возможно, стоит собирать данные с меньшей скоростью.dataPartitionId -> (строка)
Идентификатор раздела данных, с которым связан этот сигнал.
Идентификатор должен совпадать с одним из идентификаторов, указанных в dataPartitions. Это достигается либо путем указания конкретного идентификатора раздела данных, либо путем использования default для установленного значения по умолчанию раздела. Вы можете установить значение по умолчанию для раздела в типе данных DataPartition.
Примечание
Если вы загружаете сигнал в качестве условия для раздела данных кампании, тот же сигнал должен быть включен вsignalsToCollect.Предупреждение
Доступ к определенным функциям Amazon Web Services IoT FleetWise в настоящее время ограничен. Дополнительную информацию см. в разделе Доступность областей Amazon Web Services и функций в руководстве разработчика Amazon Web Services IoT FleetWise.collectionScheme -> (структура помеченных объединений)
Информация о схеме сбора данных, связанной с кампанией.
Примечание
Это структура помеченных объединений. Может быть установлено только одно из следующих ключевых слов верхнего уровня:timeBasedCollectionScheme, conditionBasedCollectionScheme.timeBasedCollectionScheme -> (структура)
Информация о схеме сбора, которая использует временной период для определения частоты сбора данных.
periodMs -> (целое число)
60000, программное обеспечение Edge Agent собирает данные один раз в минуту.conditionBasedCollectionScheme -> (структура)
Информация о схеме сбора, которая использует простое логическое выражение для определения, какие данные собирать.
expression -> (строка)
$variable.`Vehicle.OutsideAirTemperature` >= 105.0.minimumTriggerIntervalMs -> (целое число)
Минимальная продолжительность времени между двумя триггерными событиями для сбора данных, в миллисекундах.
Примечание
Если сигнал часто меняется, возможно, стоит собирать данные с меньшей скоростью.triggerMode -> (строка)
ALWAYS). Укажите (RISING_EDGE) или укажите только тогда, когда условие впервые принимает значение ложь. Например, срабатывание по «AirbagDeployed»; Пользователей не интересует срабатывание, когда подушка безопасности уже сработала; их интересует только изменение от «не сработала» => «сработала».conditionLanguageVersion -> (целое число)
dataExtraDimensions -> (список)
Список атрибутов транспортного средства, связанных с кампанией.
(строка)
creationTime -> (метка времени)
lastModificationTime -> (метка времени)
dataDestinationConfigs -> (список)
Место назначения, куда кампания отправляет данные. Вы можете отправлять данные на MQTT-тему или хранить их в Amazon S3 или Amazon Timestream.
MQTT — это протокол обмена сообщениями публикации/подписки, используемый Amazon Web Services IoT для связи с вашими устройствами.
Amazon S3 оптимизирует стоимость хранения данных и предоставляет дополнительные механизмы использования данных транспортных средств, такие как озера данных, централизованное хранилище данных, потоки обработки данных и аналитика.
Вы можете использовать Amazon Timestream для доступа и анализа данных временных рядов, а также Timestream для запроса данных транспортных средств, чтобы идентифицировать тенденции и закономерности.
(структура помеченных объединений)
Место назначения, куда кампания отправляет данные. Вы можете отправлять данные на MQTT-тему или хранить их в Amazon S3 или Amazon Timestream.
Примечание
Это структура помеченных объединений. Может быть установлено только одно из следующих ключевых слов верхнего уровня:s3Config, timestreamConfig, mqttTopicConfig.s3Config -> (структура)
Ведро Amazon S3, куда кампания Amazon Web Services IoT FleetWise отправляет данные.
bucketArn -> (строка)
dataFormat -> (строка)
Укажите формат сохранения файлов в ведре Amazon S3. Вы можете сохранять файлы в формате Apache Parquet или JSON.
- Parquet — Хранение данных в столбцовом формате файлов. Parquet оптимален для быстрого получения данных и может сократить расходы. Этот параметр выбран по умолчанию.
- JSON — Хранение данных в стандартном текстовом формате JSON.
storageCompressionFormat -> (строка)
prefix -> (строка)
Введите префикс ведра S3. Префикс — это строка символов после имени ведра и перед именем объекта. Вы можете использовать префикс для организации данных, хранящихся в ведрах Amazon S3. Дополнительную информацию см. в разделе Организация объектов с помощью префиксов в руководстве пользователя Amazon Simple Storage Service.
По умолчанию Amazon Web Services IoT FleetWise устанавливает префикс processed-data/year=YY/month=MM/date=DD/hour=HH/ (в UTC) для данных, которые он предоставляет Amazon S3. Вы можете ввести префикс, чтобы добавить его к этому префиксу по умолчанию. Например, если вы введете префикс vehicles, префикс будет vehicles/processed-data/year=YY/month=MM/date=DD/hour=HH/.
timestreamConfig -> (структура)
Таблица Amazon Timestream, куда кампания отправляет данные.
timestreamTableArn -> (строка)
executionRoleArn -> (строка)
mqttTopicConfig -> (структура)
MQTT-тема, на которую кампания Amazon Web Services IoT FleetWise маршрутизирует данные.
Предупреждение
Доступ к определенным функциям Amazon Web Services IoT FleetWise в настоящее время ограничен. Дополнительную информацию см. в разделе Доступность областей Amazon Web Services и функций в руководстве разработчика Amazon Web Services IoT FleetWise.mqttTopicArn -> (строка)
executionRoleArn -> (строка)
dataPartitions -> (список)
Разбиения данных, связанные со сигналами, собранными с транспортного средства.
(структура)
Настройка для хранения и загрузки данных сигналов. Эти параметры можно задать только при режиме накопления кампании TO_DISK .
Предупреждение
Доступ к некоторым функциям Amazon Web Services IoT FleetWise в настоящее время ограничен. Для получения дополнительной информации см. Доступность регионов и функций Amazon Web Services в руководстве разработчика Amazon Web Services IoT FleetWise.id -> (строка)
default в качестве идентификатора.storageOptions -> (структура)
Параметры хранения для разбиения данных.
maximumSize -> (структура)
Максимальный размер хранилища данных в разбиении.
Примечание
Новее данные перезаписывают более старые данные, когда разбиение достигает максимального размера.unit -> (строка)
value -> (целое число)
storageLocation -> (строка)
minimumTimeToLive -> (структура)
Время, в течение которого данные в этом разбиении будут храниться на диске.
- По истечении указанного времени данные могут быть удалены, но это не гарантируется.
- До истечения срока хранения данные в этом разбиении все еще могут быть удалены, если разбиение достигнет своего максимального размера.
- Новее данные будут перезаписывать более старые, когда разбиение достигнет максимального размера.
unit -> (строка)
value -> (целое число)
uploadOptions -> (структура)
Параметры загрузки для разбиения данных.
expression -> (строка)
$variable.`Vehicle.OutsideAirTemperature` >= 105.0 .conditionLanguageVersion -> (целое число)
signalsToFetch -> (список)
Информация о списке сигналов для получения данных.
(структура)
Информация о сигнале, который нужно получить.
Предупреждение
Доступ к некоторым функциям Amazon Web Services IoT FleetWise в настоящее время ограничен. Для получения дополнительной информации см. Доступность регионов и функций Amazon Web Services в руководстве разработчика Amazon Web Services IoT FleetWise.fullyQualifiedName -> (строка)
signalFetchConfig -> (структура с тегами)
Настройка операции получения сигнала.
Примечание
Это структура с тегами. Только один из следующих верхнеуровневых ключей может быть задан:timeBased, conditionBased.timeBased -> (структура)
Настройка операции получения сигнала по времени.
executionFrequencyMs -> (длинное целое число)
conditionBased -> (структура)
Настройка операции получения сигнала на основе условий.
conditionExpression -> (строка)
triggerMode -> (строка)
conditionLanguageVersion -> (целое число)
actions -> (список)
Действия, которые должны выполняться при получении сигнала.
(строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.