Spec-Zone.ru › AWS CLI v2

[ aws . b2bi ]

list-partnerships

Описание

Отображает партнерские связи, связанные с вашей учётной записью Amazon Web Services в текущем или указанном регионе. Партнёрская связь представляет собой связь между вами и вашим торговым партнёром. Она объединяет профиль и один или несколько торговых возможностей.

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

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

Синтаксис

  list-partnerships
[--profile-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]

Параметры

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

Указывает уникальный, сгенерированный системой идентификатор профиля, подключённого к этому партнёрству.

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

Вывод

partnerships -> (список)

Указывает список ваших партнёрств.

(структура)

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

profileId -> (строка)

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

partnershipId -> (строка)

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

name -> (строка)

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

capabilities -> (список)

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

(строка)

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

Содержит детали возможности Outbound EDI.

outboundEdi -> (меченый союз структур)

Структура, содержащая параметры Outbound EDI.

Примечание

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

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

Структура, содержащая структуру конверта X12.

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

Контейнер для заголовков X12 Outbound EDI.

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

В сообщениях X12 EDI для обозначения конца сегментов или элементов используются разделители, определённые в заголовке обмена.

senderIdQualifier -> (строка)

Расположено в позиции ISA-05 в заголовке. Квалификатор для идентификатора отправителя. Вместе идентификатор и квалификатор однозначно идентифицируют отправляющего торгового партнёра.

senderId -> (строка)

Расположено в позиции ISA-06 в заголовке. Это значение (вместе с senderIdQualifier ) идентифицирует отправителя обмена.

receiverIdQualifier -> (строка)

Расположено в позиции ISA-07 в заголовке. Квалификатор для идентификатора получателя. Вместе идентификатор и квалификатор однозначно идентифицируют получающего торгового партнёра.

receiverId -> (строка)

Расположено в позиции ISA-08 в заголовке. Это значение (вместе с receiverIdQualifier ) идентифицирует предполагаемого получателя обмена.

repetitionSeparator -> (строка)

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

Примечание

Этот параметр учитывается только для версий, больших 401 (VERSION_4010 и выше).

Для версий меньше 401 этот параметр называется StandardsId, в этом случае наше сервисное приложение устанавливает значение в U.

acknowledgmentRequestedCode -> (строка)

Расположено в позиции ISA-14 в заголовке. Значение «1» указывает, что отправитель запрашивает подтверждение обмена при его получении. В противном случае используется значение «0».

usageIndicatorCode -> (строка)

Расположено в позиции ISA-15 в заголовке. Указывает, как используется этот обмен:

  • T указывает, что этот обмен предназначен для тестирования.
  • P указывает, что этот обмен предназначен для производства.
  • I указывает, что этот обмен информационный.

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

Заголовки функциональных групп для объекта X12.

applicationSenderCode -> (строка)

Значение, представляющее код, используемый для идентификации стороны, передающей сообщение, в позиции GS-02.

applicationReceiverCode -> (строка)

Значение, представляющее код, используемый для идентификации стороны, принимающей сообщение, в позиции GS-03.

responsibleAgencyCode -> (строка)

Код, идентифицирующий издателя стандарта, в позиции GS-07.

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

Разделители, например, точка с запятой (;), разделяющие разделы заголовков для объекта X12.

componentSeparator -> (строка)

Разделитель компонентов или подэлементов. Значение по умолчанию - : (двоеточие).

dataElementSeparator -> (строка)

Разделитель элементов данных. Значение по умолчанию - * (звёздочка).

segmentTerminator -> (строка)

Разделитель сегментов. Значение по умолчанию - ~ (тильда).

validateEdi -> (булево)

Указывает, необходимо ли валидировать EDI для этого объекта X12: TRUE или FALSE.

tradingPartnerId -> (строка)

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

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

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

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

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

nextToken -> (строка)

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

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

Spec-Zone.ru

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