Spec-Zone.ru › AWS CLI v2

[ aws . b2bi ]

list-transformers

Описание

Отображает доступные трансформеры. Трансформер может принимать EDI-файл в качестве входных данных и преобразовывать его в документ в формате JSON или XML. Также, трансформер может принимать документ в формате JSON или XML в качестве входных данных и преобразовывать его в EDI-файл.

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

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

Синтаксис

  list-transformers
[--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]

Параметры

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

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

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

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

--page-size (целое число)

Размер каждой страницы для получения в вызове AWS-сервиса. Это не влияет на количество элементов, возвращаемых в выводе команды. Установка меньшего размера страницы приводит к большему количеству вызовов AWS-сервиса, получая меньше элементов в каждом вызове. Это может помочь предотвратить истечение времени ожидания AWS-сервиса.

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

--max-items (целое число)

Общее количество элементов для возврата в выводе команды. Если общее количество доступных элементов больше указанного значения, в выводе команды предоставляется NextToken. Чтобы продолжить постраничный вывод, укажите значение NextToken в аргументе starting-token последующей команды. **Не** используйте элемент ответа NextToken напрямую вне AWS CLI.

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

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

Вывод

transformers -> (список)

Возвращает массив одного или нескольких объектов преобразователя.

Для каждого преобразователя возвращается объект TransformerSummary. Объект TransformerSummary содержит все детали для конкретного преобразователя.

(структура)

Содержит детали объекта преобразователя. Преобразователь может принимать файл EDI в качестве входных данных и преобразовывать его в документ в формате JSON или XML. Или же преобразователь может принимать документ в формате JSON или XML в качестве входных данных и преобразовывать его в файл EDI.

transformerId -> (строка)

Возвращает уникальный идентификатор, присвоенный системе, для преобразователя.

name -> (строка)

Возвращает описательное имя преобразователя.

status -> (строка)

Возвращает состояние недавно созданного преобразователя. Преобразователь может быть либо active, либо inactive. Для использования преобразователя в функциональности, его состояние должно быть active.

createdAt -> (метка времени)

Возвращает метку времени, указывающую, когда был создан преобразователь. Например, 2023-07-20T19:58:44.624Z.

modifiedAt -> (метка времени)

Возвращает метку времени, представляющую дату и время последнего изменения объекта преобразователя.

fileFormat -> (строка)

Возвращает, что в настоящее время поддерживаются следующие форматы файлов для преобразований EDI: JSON и XML.

mappingTemplate -> (строка)

Возвращает шаблон сопоставления для преобразователя. Этот шаблон используется для сопоставления проанализированного файла EDI с помощью JSONata или XSLT.

ediType -> (структура помеченной выборки)

Возвращает сведения о стандарте EDI, используемом для преобразователя. В настоящее время поддерживается только X12. X12 — это набор стандартов и соответствующих сообщений, которые определяют конкретные бизнес-документы.

Примечание

Это структура помеченной выборки. Может быть установлен только один из следующих ключей верхнего уровня: x12Details.

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

Возвращает сведения о стандарте EDI, используемом для преобразователя. В настоящее время поддерживается только X12. X12 — это набор стандартов и соответствующих сообщений, которые определяют конкретные бизнес-документы.

transactionSet -> (строка)

Возвращает перечисляемый тип, где каждое значение идентифицирует набор транзакций X12. Наборы транзакций поддерживаются Комитетом по стандартизации X12.

version -> (строка)

Возвращает версию, используемую для указанного набора транзакций X12.

sampleDocument -> (строка)

Возвращает пример EDI-документа, используемый преобразователем в качестве руководства для обработки данных EDI.

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

Возвращает структуру, содержащую параметры формата для преобразования.

fromFormat -> (строка)

Формат входных данных преобразователя: в настоящее время поддерживается X12.

formatOptions -> (структура помеченной выборки)

Структура, содержащая параметры форматирования для входного преобразователя.

Примечание

Это структура помеченной выборки. Может быть установлен только один из следующих ключей верхнего уровня: x12.

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

Структура, содержащая набор транзакций X12 и версию. Структура X12 используется, когда система преобразует файл EDI (обмена электронными данными).

Примечание

Если файл входных EDI содержит более одной транзакции, каждая транзакция должна иметь одинаковый набор транзакций и версию, например, 214/4010. В противном случае преобразователь не сможет обработать файл.

transactionSet -> (строка)

Возвращает перечисляемый тип, где каждое значение идентифицирует набор транзакций X12. Наборы транзакций поддерживаются Комитетом по стандартизации X12.

version -> (строка)

Возвращает версию, используемую для указанного набора транзакций X12.

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

Возвращает структуру, содержащую шаблон сопоставления и его язык (XSLT или JSONATA).

templateLanguage -> (строка)

Язык преобразования для шаблона, либо XSLT, либо JSONATA.

template -> (строка)

Строка, представляющая шаблон сопоставления, на языке преобразования, указанном в templateLanguage.

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

Возвращает объект OutputConversion, содержащий параметры формата для исходящего преобразования.

toFormat -> (строка)

Формат вывода исходящего преобразователя: в настоящее время поддерживается только X12.

formatOptions -> (структура помеченной выборки)

Структура, содержащая набор транзакций X12 и версию для вывода преобразователя.

Примечание

Это структура помеченной выборки. Может быть установлен только один из следующих ключей верхнего уровня: x12.

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

Структура, содержащая набор транзакций X12 и версию. Структура X12 используется, когда система преобразует файл EDI (обмена электронными данными).

Примечание

Если файл входных EDI содержит более одной транзакции, каждая транзакция должна иметь одинаковый набор транзакций и версию, например, 214/4010. В противном случае преобразователь не сможет обработать файл.

transactionSet -> (строка)

Возвращает перечисляемый тип, где каждое значение идентифицирует набор транзакций X12. Наборы транзакций поддерживаются Комитетом по стандартизации X12.

version -> (строка)

Возвращает версию, используемую для указанного набора транзакций X12.

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

Возвращает структуру, содержащую ведро Amazon S3 и массив соответствующих ключей, используемых для идентификации расположения ваших образцов документов.

bucketName -> (строка)

Содержит ведро Amazon S3, используемое для хранения ваших образцов документов.

keys -> (список)

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

(структура)

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

input -> (строка)

Массив ключей для ваших входных образцов документов.

output -> (строка)

Массив ключей для ваших выходных образцов документов.

nextToken -> (строка)

При получении дополнительных результатов из команды в выводе возвращается параметр NextToken. Затем вы можете передать параметр NextToken в последующей команде для продолжения перечисления дополнительных ресурсов.

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

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

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