Spec-Zone.ru › AWS CLI v2

[ aws . supplychain ]

Список событий интеграции данных

Описание

Позволяет программно перечислить все события интеграции данных для предоставленного экземпляра Amazon Web Services Supply Chain.

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

list-data-integration-events является постраничной операцией. Для получения всего набора результатов могут быть выполнены несколько вызовов API. Вы можете отключить постраничность, предоставив аргумент --no-paginate. При использовании --output text и аргумента --query в ответ на постраничный запрос, аргумент --query должен извлекать данные из результатов следующих выражений запроса: events

Синтаксис

  list-data-integration-events
--instance-id <value>
[--event-type <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]

Параметры

--instance-id (строка)

Идентификатор экземпляра Amazon Web Services Supply Chain.

--event-type (строка)

Перечисляет события интеграции данных для указанного типа события.

Возможные значения:

  • scn.data.forecast
  • scn.data.inventorylevel
  • scn.data.inboundorder
  • scn.data.inboundorderline
  • scn.data.inboundorderlineschedule
  • scn.data.outboundorderline
  • scn.data.outboundshipment
  • scn.data.processheader
  • scn.data.processoperation
  • scn.data.processproduct
  • scn.data.reservation
  • scn.data.shipment
  • scn.data.shipmentstop
  • scn.data.shipmentstoporder
  • scn.data.supplyplan
  • scn.data.dataset

--cli-input-json | --cli-input-yaml (строка) Считывает аргументы из предоставленной строки JSON. Строка JSON соответствует формату, предоставленному --generate-cli-skeleton. Если другие аргументы предоставлены в командной строке, эти значения переопределят значения, предоставленные JSON. Невозможно передать произвольные двоичные значения с помощью предоставленного значения JSON, так как строка будет взята дословно. Это не может быть указано вместе с --cli-input-yaml.

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

Токен для указания начала постраничной выборки. Это NextToken из ранее усеченного ответа.

Примеры использования см. в разделе Постраничная выборка в руководстве пользователя AWS CLI.

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

Вывод

events -> (список)

Список событий интеграции данных.

(структура)

Подробности события интеграции данных.

instanceId -> (строка)

Идентификатор экземпляра AWS Supply Chain.

eventId -> (строка)

Уникальный идентификатор события.

eventType -> (строка)

Тип события данных.

eventGroupId -> (строка)

Идентификатор события (например, orderId для InboundOrder), используемый для фрагментации или разделения данных.

eventTimestamp -> (временная метка)

Временная метка события (в секундах эпохи).

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

Подробности целевого набора данных для типа события DATASET.

datasetIdentifier -> (строка)

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

operationType -> (строка)

Тип операции загрузки целевого набора данных. Доступные варианты:

  • APPEND - Добавление новых записей в набор данных. Обратите внимание, что эта операция просто пытается добавить записи как есть без каких-либо ограничений по первичному ключу или разбиению.
  • UPSERT - Изменение существующих записей в наборе данных с настроенным первичным ключом, события для наборов данных без первичных ключей не допускаются. Если данные события содержат первичные ключи, соответствующие записям в наборе данных в том же разделе, то эти существующие записи (в этом разделе) будут обновлены. Если первичные ключи не совпадают, будут добавлены новые записи. Обратите внимание, что если набор данных содержит записи с дублированными значениями первичного ключа в том же разделе, эти дублированные записи будут объединены в одну обновленную запись.
  • DELETE - Удаление существующих записей в наборе данных с настроенным первичным ключом, события для наборов данных без первичных ключей не допускаются. Если данные события содержат первичные ключи, соответствующие записям в наборе данных в том же разделе, то эти существующие записи (в этом разделе) будут удалены. Если первичные ключи не совпадают, никаких действий не будет выполнено. Обратите внимание, что если набор данных содержит записи с дублированными значениями первичного ключа в том же разделе, все эти дубликаты будут удалены.

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

Выполнение загрузки целевого набора данных.

status -> (строка)

Статус выполнения загрузки события в целевой набор данных.

message -> (строка)

Сообщение об ошибке (если есть) при сбое выполнения загрузки события в набор данных.

nextToken -> (строка)

Токен постраничной выборки для получения следующей страницы ListDataIntegrationEvents.

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

Spec-Zone.ru

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