[ aws . iotfleetwise ]
list-campaigns
Описание
Отображает информацию о созданных кампаниях.
Примечание
Данная операция API использует постраничный вывод. Укажите параметрnextToken в запросе для получения дополнительных результатов.См. также: Документацию API AWS
list-campaigns является постраничной операцией. Для получения всех результатов может потребоваться несколько вызовов API. Вы можете отключить постраничный вывод, указав аргумент --no-paginate. При использовании --output text и аргумента --query в ответе с постраничным выводом, аргумент --query должен извлекать данные из результатов следующих выражений запроса: campaignSummaries
Синтаксис
list-campaigns
[--status <value>]
[--list-response-scope <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--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]
Параметры
--status (строка)
CREATING , WAITING_FOR_APPROVAL , RUNNING или SUSPENDED.--list-response-scope (строка)
При установке параметра listResponseScope в значение METADATA_ONLY ответ списка включает: имя кампании, Amazon Resource Name (ARN), время создания и время последнего изменения.
Возможные значения:
METADATA_ONLY
--cli-input-json | --cli-input-yaml (строка) Считывает аргументы из предоставленной JSON строки. Строка JSON следует формату, предоставленному --generate-cli-skeleton. Если другие аргументы предоставлены в командной строке, эти значения переопределят значения, предоставленные JSON. Невозможно передавать произвольные двоичные значения, используя значение, предоставленное JSON, так как строка будет воспринята буквально. Это не может быть указано вместе с --cli-input-yaml.
--starting-token (строка)
Токен для указания, с какой точки начать постраничный вывод. Это NextToken из ранее усеченного ответа.
Примеры использования см. в разделе Постраничный вывод в Руководстве пользователя AWS Command Line Interface.
--page-size (целое число)
Размер каждой страницы для вызова AWS сервиса. Это не влияет на количество элементов, возвращаемых в выводе команды. Установка меньшего размера страницы приводит к большему количеству вызовов AWS сервиса, извлекая меньше элементов в каждом вызове. Это может помочь предотвратить истечение времени ожидания вызовов AWS сервиса.
Примеры использования см. в разделе Постраничный вывод в Руководстве пользователя AWS Command Line Interface.
--max-items (целое число)
Общее количество элементов для возврата в выводе команды. Если общее количество доступных элементов превышает указанное значение, в выводе команды предоставляется NextToken. Для возобновления постраничного вывода, предоставьте значение NextToken в аргументе starting-token последующей команды. Не используйте элемент ответа NextToken напрямую вне AWS CLI.
Примеры использования см. в разделе Постраничный вывод в Руководстве пользователя AWS Command Line Interface.
--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.
Вывод
campaignSummaries -> (список)
Сводка информации о каждой кампании.
(структура)
Информация о кампании.
Вы можете использовать операцию API для получения этой информации о нескольких созданных кампаниях.
arn -> (строка)
name -> (строка)
description -> (строка)
signalCatalogArn -> (строка)
targetArn -> (строка)
status -> (строка)
Состояние кампании. Статус может быть одним из следующих:
-
CREATING- Amazon Web Services IoT FleetWise обрабатывает ваш запрос на создание кампании. -
WAITING_FOR_APPROVAL- После создания кампания переходит в состояниеWAITING_FOR_APPROVAL. Чтобы разрешить Amazon Web Services IoT FleetWise развернуть кампанию на целевом транспортном средстве или флоте, используйте операцию API для одобрения кампании. -
RUNNING- Кампания активна. -
SUSPENDED- Кампания приостановлена. Чтобы возобновить кампанию, используйте операцию API.
creationTime -> (метка времени)
lastModificationTime -> (метка времени)
nextToken -> (строка)
null, если больше результатов нет.
© Copyright 2025, Amazon Web Services. Created using Sphinx.