Spec-Zone.ru › AWS CLI v2

[ aws . b2bi ]

create-partnership

Описание

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

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

Синтаксис

  create-partnership
--profile-id <value>
--name <value>
--email <value>
[--phone <value>]
--capabilities <value>
[--capability-options <value>]
[--client-token <value>]
[--tags <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]

Параметры

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

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

--name (строка)

Указывает описательное имя для партнёрства.

--email (строка)

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

--phone (строка)

Указывает номер телефона, связанный с партнёрством.

--capabilities (список)

Указывает список возможностей, связанных с этим партнёрством.

(строка)

Синтаксис:

"string" "string" ...

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

Укажите структуру, содержащую детали связанных возможностей.

outboundEdi -> (структура помеченных объединений)

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

Примечание

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

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

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

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

Контейнер для заголовков исходящего EDI X12.

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.

JSON Синтаксис:

{
  "outboundEdi": {
    "x12": {
      "common": {
        "interchangeControlHeaders": {
          "senderIdQualifier": "string",
          "senderId": "string",
          "receiverIdQualifier": "string",
          "receiverId": "string",
          "repetitionSeparator": "string",
          "acknowledgmentRequestedCode": "string",
          "usageIndicatorCode": "string"
        },
        "functionalGroupHeaders": {
          "applicationSenderCode": "string",
          "applicationReceiverCode": "string",
          "responsibleAgencyCode": "string"
        },
        "delimiters": {
          "componentSeparator": "string",
          "dataElementSeparator": "string",
          "segmentTerminator": "string"
        },
        "validateEdi": true|false
      }
    }
  }
}

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

Зарезервировано для будущего использования.

--tags (список)

Указывает пары ключ-значение, присвоенные ARNs, которые вы можете использовать для группирования и поиска ресурсов по типу. Вы можете прикрепить эти метаданные к ресурсам (возможностям, партнёрствам и т. д.) для любых целей.

(структура)

Создаёт пару ключ-значение для конкретного ресурса. Теги — это метаданные, которые вы можете использовать для поиска и группирования ресурса для различных целей. Вы можете применять теги к возможностям, партнёрствам, профилям и преобразователям. Ключ тега может принимать несколько значений. Например, чтобы сгруппировать возможности для бухгалтерского учёта, вы можете создать тег, называемый Group, и назначить значения Research и Accounting этой группе.

Key -> (строка)

Указывает имя, назначенное тегу, который вы создаёте.

Value -> (строка)

Содержит одно или несколько значений, которые вы назначили имени ключа, которое вы создали.

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

Key=string,Value=string ...

JSON Синтаксис:

[
  {
    "Key": "string",
    "Value": "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 (логическое значение)

Включить отладку регистрации.

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

Вывод

profileId -> (строка)

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

partnershipId -> (строка)

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

partnershipArn -> (строка)

Возвращает Amazon Resource Name (ARN) для определенного ресурса Amazon Web Services, такого как возможность, партнерство, профиль или преобразователь.

name -> (строка)

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

email -> (строка)

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

phone -> (строка)

Возвращает номер телефона, связанный с партнерством.

capabilities -> (список)

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

(строка)

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

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

outboundEdi -> (структура помеченного объединения)

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

Примечание

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

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

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

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

Контейнер для заголовков исходящего EDI X12.

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 -> (временная метка)

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

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

Spec-Zone.ru

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