Spec-Zone.ru › AWS CLI v2

[ aws . supplychain ]

list-data-integration-flows

Описание

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

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

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

Синтаксис

  list-data-integration-flows
--instance-id <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.

--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
  • table
  • yaml
  • yaml-stream

--query (строка)

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

--profile (строка)

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

--region (строка)

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

--version (строка)

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

--color (строка)

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

  • on
  • off
  • auto

--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.

Вывод

flows -> (список)

Параметры ответа для ListDataIntegrationFlows.

(структура)

Подробности DataIntegrationFlow.

instanceId -> (строка)

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

name -> (строка)

Имя DataIntegrationFlow.

sources -> (список)

Настройки источника DataIntegrationFlow.

(структура)

Параметры источника DataIntegrationFlow.

sourceType -> (строка)

Тип источника DataIntegrationFlow.

sourceName -> (строка)

Имя источника DataIntegrationFlow, которое может использоваться в качестве псевдонима таблицы в запросе SQL-преобразования.

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

Источник DataIntegrationFlow S3.

bucketName -> (строка)

Имя корзины объектов S3-источника.

prefix -> (строка)

Префикс объектов S3-источника. Для запуска загрузки данных файлы S3 должны быть размещены в папке s3://*bucketName* /*prefix* / .

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

Дополнительные параметры источника S3 DataIntegrationFlow.

fileType -> (строка)

Тип файла Amazon S3 в параметрах S3.

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

Источник DataIntegrationFlow набора данных.

datasetIdentifier -> (строка)

ARN набора данных.

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

Параметры источника DataIntegrationFlow набора данных.

loadType -> (строка)

Тип загрузки данных целевого набора данных. Это влияет только на то, как выбираются исходные файлы S3 в потоке S3-набора данных.

  • REPLACE - Целевой набор данных будет заменен новым файлом, добавленным в префикс исходного s3.
  • INCREMENTAL - Целевой набор данных будет обновлен с актуальным содержимым в префиксе S3, учитывая все добавленные или удаленные файлы.

dedupeRecords -> (логическое)

Параметр для выполнения дедупликации записей данных, имеющих одинаковые значения первичного ключа. Если отключено, преобразованные данные с дубликатами первичных ключей будут загружаться в набор данных. Для наборов данных в пространстве имен asc такие дубликаты приведут к ошибке загрузки. Если включено без dedupeStrategy, дедупликация выполняется путем сохранения случайной записи данных среди тех, которые имеют одинаковые значения первичного ключа. Если включено с dedupeStragtegy, дедупликация выполняется в соответствии со стратегией.

Обратите внимание, что целевой набор данных может иметь конфигурацию разбиения. При включенной дедупликации она выполняется только по первичным ключам, и из дубликатов сохраняется только одна запись независимо от состояния разбиения.

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

Стратегия дедупликации для дедупликации записей данных, имеющих одинаковые значения первичного ключа целевого набора данных. Эта стратегия применяется только к целевым наборам данных с первичными ключами и с включенным параметром dedupeRecords. Если после оценки dedupeStrategy преобразованные данные все еще содержат дубликаты, для сохранения выбирается случайная запись данных.

type -> (строка)

Тип стратегии дедупликации.

  • FIELD_PRIORITY - Конфигурация приоритета поля для стратегии дедупликации определяет упорядоченный список полей, используемых для разрешения конфликтов при одинаковых значениях первичных ключей. Поля в начале списка имеют более высокий приоритет. Для каждого поля порядок сортировки определяет, сохранять ли запись данных с большим или меньшим значением поля.

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

Стратегия дедупликации по приоритету поля.

fields -> (список)

Список имен полей и их порядка сортировки для дедупликации, упорядоченные по убыванию приоритета.

(структура)

Поле, используемое в стратегии дедупликации по приоритету поля.

name -> (строка)

Имя поля дедупликации. Должно существовать в наборе данных и не быть первичным ключом.

sortOrder -> (строка)

Порядок сортировки для поля дедупликации.

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

Настройки преобразования DataIntegrationFlow.

transformationType -> (строка)

Тип преобразования DataIntegrationFlow.

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

Настройка SQL-преобразования DataIntegrationFlow.

query -> (строка)

Тело запроса SQL-преобразования, основанное на SparkSQL.

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

Настройки целевого объекта DataIntegrationFlow.

targetType -> (строка)

Тип целевого объекта DataIntegrationFlow.

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

Целевой объект S3 DataIntegrationFlow.

bucketName -> (строка)

Имя корзины целевых объектов S3.

prefix -> (строка)

Префикс целевых объектов S3.

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

Параметры целевого объекта S3 DataIntegrationFlow.

fileType -> (строка)

Тип файла Amazon S3 в параметрах S3.

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

Целевой объект DataIntegrationFlow набора данных. Обратите внимание, что для набора данных AWS Supply Chain в пространстве имен asc есть внутреннее поле connection_id, которое не может быть предоставлено клиентом напрямую, оно будет автоматически заполняться.

datasetIdentifier -> (строка)

ARN набора данных.

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

Параметры целевого объекта DataIntegrationFlow набора данных.

loadType -> (строка)

Тип загрузки данных целевого набора данных. Это влияет только на то, как выбираются исходные файлы S3 в потоке S3-набора данных.

  • REPLACE - Целевой набор данных будет заменен новым файлом, добавленным в префикс исходного s3.
  • INCREMENTAL - Целевой набор данных будет обновлен с актуальным содержимым в префиксе S3, учитывая все добавленные или удаленные файлы.

dedupeRecords -> (логическое)

Параметр для выполнения дедупликации записей данных, имеющих одинаковые значения первичного ключа. Если отключено, преобразованные данные с дубликатами первичных ключей будут загружаться в набор данных. Для наборов данных в пространстве имен asc такие дубликаты приведут к ошибке загрузки. Если включено без dedupeStrategy, дедупликация выполняется путем сохранения случайной записи данных среди тех, которые имеют одинаковые значения первичного ключа. Если включено с dedupeStragtegy, дедупликация выполняется в соответствии со стратегией.

Обратите внимание, что целевой набор данных может иметь конфигурацию разбиения. При включенной дедупликации она выполняется только по первичным ключам, и из дубликатов сохраняется только одна запись независимо от состояния разбиения.

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

Стратегия дедупликации для дедупликации записей данных, имеющих одинаковые значения первичного ключа целевого набора данных. Эта стратегия применяется только к целевым наборам данных с первичными ключами и с включенным параметром dedupeRecords. Если после оценки dedupeStrategy преобразованные данные все еще содержат дубликаты, для сохранения выбирается случайная запись данных.

type -> (строка)

Тип стратегии дедупликации.

  • FIELD_PRIORITY - Конфигурация приоритета поля для стратегии дедупликации определяет упорядоченный список полей, используемых для разрешения конфликтов при одинаковых значениях первичных ключей. Поля в начале списка имеют более высокий приоритет. Для каждого поля порядок сортировки определяет, сохранять ли запись данных с большим или меньшим значением поля.

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

Стратегия дедупликации по приоритету поля.

fields -> (список)

Список имен полей и их порядка сортировки для дедупликации, упорядоченные по убыванию приоритета.

(структура)

Поле, используемое в стратегии дедупликации по приоритету поля.

name -> (строка)

Имя поля дедупликации. Должно существовать в наборе данных и не быть первичным ключом.

sortOrder -> (строка)

Порядок сортировки для поля дедупликации.

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

Временная метка создания DataIntegrationFlow.

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

Временная метка последнего изменения DataIntegrationFlow.

nextToken -> (строка)

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

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

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

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