создание-кампании

Описание

Создаёт оркестрацию правил сбора данных. Программное обеспечение агента Amazon Web Services IoT FleetWise Edge, работающее в транспортных средствах, использует кампании для определения того, как собирать и передавать данные в облако. Вы создаёте кампании в облаке. После утверждения кампаний вами или вашей командой, Amazon Web Services IoT FleetWise автоматически развертывает их на транспортных средствах.

Для получения дополнительной информации см. Сбор и передача данных с помощью кампаний в руководстве разработчика Amazon Web Services IoT FleetWise.

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

Синтаксис

  create-campaign
--name <value>
[--description <value>]
--signal-catalog-arn <value>
--target-arn <value>
[--start-time <value>]
[--expiry-time <value>]
[--post-trigger-collection-duration <value>]
[--diagnostics-mode <value>]
[--spooling-mode <value>]
[--compression <value>]
[--priority <value>]
[--signals-to-collect <value>]
--collection-scheme <value>
[--data-extra-dimensions <value>]
[--tags <value>]
[--data-destination-configs <value>]
[--data-partitions <value>]
[--signals-to-fetch <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 (строка)

--description (строка)

--signal-catalog-arn (строка)

--target-arn (строка)

--start-time (метка времени)

--expiry-time (метка времени)

--post-trigger-collection-duration (целое число)

--diagnostics-mode (строка)

--spooling-mode (строка)

--compression (строка)

--priority (целое число)

--signals-to-collect (список)

Упрощённый синтаксис:

name=string,maxSampleCount=long,minimumSamplingIntervalMs=long,dataPartitionId=string ...

Синтаксис JSON:

[
  {
    "name": "string",
    "maxSampleCount": long,
    "minimumSamplingIntervalMs": long,
    "dataPartitionId": "string"
  }
  ...
]

--collection-scheme (структура помеченного союза)

Упрощённый синтаксис:

timeBasedCollectionScheme={periodMs=long},conditionBasedCollectionScheme={expression=string,minimumTriggerIntervalMs=long,triggerMode=string,conditionLanguageVersion=integer}

Синтаксис JSON:

{
  "timeBasedCollectionScheme": {
    "periodMs": long
  },
  "conditionBasedCollectionScheme": {
    "expression": "string",
    "minimumTriggerIntervalMs": long,
    "triggerMode": "ALWAYS"|"RISING_EDGE",
    "conditionLanguageVersion": integer
  }
}

--data-extra-dimensions (список)

Синтаксис:

"string" "string" ...

--tags (список)

Упрощённый синтаксис:

Key=string,Value=string ...

Синтаксис JSON:

[
  {
    "Key": "string",
    "Value": "string"
  }
  ...
]

--data-destination-configs (список)

Сокращенная синтаксическая запись:

s3Config={bucketArn=string,dataFormat=string,storageCompressionFormat=string,prefix=string},timestreamConfig={timestreamTableArn=string,executionRoleArn=string},mqttTopicConfig={mqttTopicArn=string,executionRoleArn=string} ...

Синтаксис JSON:

[
  {
    "s3Config": {
      "bucketArn": "string",
      "dataFormat": "JSON"|"PARQUET",
      "storageCompressionFormat": "NONE"|"GZIP",
      "prefix": "string"
    },
    "timestreamConfig": {
      "timestreamTableArn": "string",
      "executionRoleArn": "string"
    },
    "mqttTopicConfig": {
      "mqttTopicArn": "string",
      "executionRoleArn": "string"
    }
  }
  ...
]

--data-partitions (список)

Сокращенная синтаксическая запись:

id=string,storageOptions={maximumSize={unit=string,value=integer},storageLocation=string,minimumTimeToLive={unit=string,value=integer}},uploadOptions={expression=string,conditionLanguageVersion=integer} ...

Синтаксис JSON:

[
  {
    "id": "string",
    "storageOptions": {
      "maximumSize": {
        "unit": "MB"|"GB"|"TB",
        "value": integer
      },
      "storageLocation": "string",
      "minimumTimeToLive": {
        "unit": "HOURS"|"DAYS"|"WEEKS",
        "value": integer
      }
    },
    "uploadOptions": {
      "expression": "string",
      "conditionLanguageVersion": integer
    }
  }
  ...
]

--signals-to-fetch (список)

Сокращенная синтаксическая запись:

fullyQualifiedName=string,signalFetchConfig={timeBased={executionFrequencyMs=long},conditionBased={conditionExpression=string,triggerMode=string}},conditionLanguageVersion=integer,actions=string,string ...

Синтаксис JSON:

[
  {
    "fullyQualifiedName": "string",
    "signalFetchConfig": {
      "timeBased": {
        "executionFrequencyMs": long
      },
      "conditionBased": {
        "conditionExpression": "string",
        "triggerMode": "ALWAYS"|"RISING_EDGE"
      }
    },
    "conditionLanguageVersion": integer,
    "actions": ["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 (boolean)

Включить отладку логирования.

--endpoint-url (string)

Заменить адрес по умолчанию команды на указанный адрес.

--no-verify-ssl (boolean)

По умолчанию AWS CLI использует SSL при взаимодействии с AWS-сервисами. Для каждого SSL-соединения AWS CLI будет проверять SSL-сертификаты. Этот параметр переопределяет поведение проверки SSL-сертификатов по умолчанию.

--no-paginate (boolean)

Отключить автоматическую постраничную навигацию. Если автоматическая постраничная навигация отключена, AWS CLI выполнит только один вызов для первой страницы результатов.

--output (string)

Стиль форматирования вывода команды.

• json
• text
• table
• yaml
• yaml-stream

--query (string)

Запрос JMESPath для фильтрации данных ответа.

--profile (string)

Использовать определённый профиль из файла учетных данных.

--region (string)

Регион для использования. Переопределяет настройки конфигурации/среды.

--version (string)

Отобразить версию этого инструмента.

--color (string)

Включить/выключить цветной вывод.

• on
• off
• auto

--no-sign-request (boolean)

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

--ca-bundle (string)

Файл с корневым сертификатом для проверки SSL-сертификатов. Переопределяет настройки конфигурации/среды.

--cli-read-timeout (int)

Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет выполняться блокирующим образом и без таймаута. Значение по умолчанию - 60 секунд.

--cli-connect-timeout (int)

Максимальное время подключения сокета в секундах. Если значение установлено в 0, подключение сокета будет выполняться блокирующим образом и без таймаута. Значение по умолчанию - 60 секунд.

--cli-binary-format (string)

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

Отключить вывод страницы CLI.

--cli-auto-prompt (boolean)

Автоматически запрашивать параметры ввода CLI.

--no-cli-auto-prompt (boolean)

Отключить автоматическое запроса параметров ввода CLI.

Вывод

name -> (string)

arn -> (string)