Spec-Zone.ru › AWS CLI v2

[ aws . partnercentral-selling ]

create-engagement

Описание

Действие CreateEngagement позволяет создать Engagement, которое служит совместным пространством для различных сторон, таких как партнеры AWS и продавцы AWS. Это действие автоматически добавляет учётную запись вызывающего лица AWS в качестве активного участника вновь созданного Engagement.

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

Синтаксис

  create-engagement
--catalog <value>
[--client-token <value>]
[--contexts <value>]
--description <value>
--title <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]

Параметры

--catalog (строка)

Параметр CreateEngagementRequest$Catalog определяет каталог, связанный с вовлечением. Допустимые значения — AWS и Sandbox, которые определяют среду, в которой управляется вовлечение.

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

Параметр CreateEngagementRequest$ClientToken определяет уникальный, чувствительный к регистру идентификатор для обеспечения обработки запроса ровно один раз. Значение не должно превышать шестьдесят четыре алфавитно-цифровых символа.

--contexts (список)

Поле Contexts — это обязательный массив объектов, с максимальным количеством 5 контекстов, определяющий подробную информацию о проектах клиентов, связанных с вовлечением. Каждый объект контекста содержит поле Type, указывающее тип контекста, который должен быть CustomerProject в этой версии, и поле Payload, содержащее подробности CustomerProject. Объект CustomerProject состоит из двух основных компонентов: Customer и Project. Объект Customer содержит информацию, такую как CompanyName, WebsiteUrl, Industry и CountryCode, предоставляя существенные детали о клиенте. Объект Project содержит Title, BusinessProblem и TargetCompletionDate, предоставляя информацию о конкретном проекте, связанном с клиентом. Эта структура позволяет включить всестороннюю информацию в вовлечение, способствуя эффективному сотрудничеству между сторонами, предоставляя актуальные сведения о клиенте и проекте.

(структура)

Предоставляет подробную информацию о контексте вовлечения. Эта структура позволяет указать тип контекста и его полезную нагрузку.

Полезная нагрузка -> (структура помеченных союзов)

Содержит конкретные детали контекста вовлечения. Структура этой полезной нагрузки варьируется в зависимости от поля Тип.

Примечание

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

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

Содержит подробную информацию о проекте клиента, когда тип контекста равен «CustomerProject». Это поле присутствует только в том случае, если Type в EngagementContextDetails задано как «CustomerProject».

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

Содержит данные о клиенте, связанном с приглашением к вовлечению, включая информацию о компании и отрасли.

CompanyName -> (строка)

Представляет имя компании клиента, связанной с приглашением к вовлечению. Это поле используется для идентификации клиента.

CountryCode -> (строка)

Указывает страну, в которой работает компания клиента. Это поле полезно для понимания региональных требований или потребностей соответствия.

Industry -> (строка)

Определяет отрасль, к которой принадлежит компания клиента. Это поле помогает классифицировать возможность на основе отрасли деятельности клиента.

WebsiteUrl -> (строка)

Предоставляет URL-адрес веб-сайта компании клиента. Это поле помогает партнерам проверить легитимность и размер организации клиента.

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

Информация о проекте клиента, связанном с вовлечением.

BusinessProblem -> (строка)

Описание бизнес-проблемы, которую призван решить проект.

TargetCompletionDate -> (строка)

Целевая дата завершения проекта клиента.

Title -> (строка)

Название проекта.

Type -> (строка)

Указывает тип контекста вовлечения. Допустимые значения — «CustomerProject» или «Document», указывающие, относится ли контекст к проекту клиента или документу соответственно.

Синтаксис JSON:

[
  {
    "Payload": {
      "CustomerProject": {
        "Customer": {
          "CompanyName": "string",
          "CountryCode": "US"|"AF"|"AX"|"AL"|"DZ"|"AS"|"AD"|"AO"|"AI"|"AQ"|"AG"|"AR"|"AM"|"AW"|"AU"|"AT"|"AZ"|"BS"|"BH"|"BD"|"BB"|"BY"|"BE"|"BZ"|"BJ"|"BM"|"BT"|"BO"|"BQ"|"BA"|"BW"|"BV"|"BR"|"IO"|"BN"|"BG"|"BF"|"BI"|"KH"|"CM"|"CA"|"CV"|"KY"|"CF"|"TD"|"CL"|"CN"|"CX"|"CC"|"CO"|"KM"|"CG"|"CK"|"CR"|"CI"|"HR"|"CU"|"CW"|"CY"|"CZ"|"CD"|"DK"|"DJ"|"DM"|"DO"|"EC"|"EG"|"SV"|"GQ"|"ER"|"EE"|"ET"|"FK"|"FO"|"FJ"|"FI"|"FR"|"GF"|"PF"|"TF"|"GA"|"GM"|"GE"|"DE"|"GH"|"GI"|"GR"|"GL"|"GD"|"GP"|"GU"|"GT"|"GG"|"GN"|"GW"|"GY"|"HT"|"HM"|"VA"|"HN"|"HK"|"HU"|"IS"|"IN"|"ID"|"IR"|"IQ"|"IE"|"IM"|"IL"|"IT"|"JM"|"JP"|"JE"|"JO"|"KZ"|"KE"|"KI"|"KR"|"KW"|"KG"|"LA"|"LV"|"LB"|"LS"|"LR"|"LY"|"LI"|"LT"|"LU"|"MO"|"MK"|"MG"|"MW"|"MY"|"MV"|"ML"|"MT"|"MH"|"MQ"|"MR"|"MU"|"YT"|"MX"|"FM"|"MD"|"MC"|"MN"|"ME"|"MS"|"MA"|"MZ"|"MM"|"NA"|"NR"|"NP"|"NL"|"AN"|"NC"|"NZ"|"NI"|"NE"|"NG"|"NU"|"NF"|"MP"|"NO"|"OM"|"PK"|"PW"|"PS"|"PA"|"PG"|"PY"|"PE"|"PH"|"PN"|"PL"|"PT"|"PR"|"QA"|"RE"|"RO"|"RU"|"RW"|"BL"|"SH"|"KN"|"LC"|"MF"|"PM"|"VC"|"WS"|"SM"|"ST"|"SA"|"SN"|"RS"|"SC"|"SL"|"SG"|"SX"|"SK"|"SI"|"SB"|"SO"|"ZA"|"GS"|"SS"|"ES"|"LK"|"SD"|"SR"|"SJ"|"SZ"|"SE"|"CH"|"SY"|"TW"|"TJ"|"TZ"|"TH"|"TL"|"TG"|"TK"|"TO"|"TT"|"TN"|"TR"|"TM"|"TC"|"TV"|"UG"|"UA"|"AE"|"GB"|"UM"|"UY"|"UZ"|"VU"|"VE"|"VN"|"VG"|"VI"|"WF"|"EH"|"YE"|"ZM"|"ZW",
          "Industry": "Aerospace"|"Agriculture"|"Automotive"|"Computers and Electronics"|"Consumer Goods"|"Education"|"Energy - Oil and Gas"|"Energy - Power and Utilities"|"Financial Services"|"Gaming"|"Government"|"Healthcare"|"Hospitality"|"Life Sciences"|"Manufacturing"|"Marketing and Advertising"|"Media and Entertainment"|"Mining"|"Non-Profit Organization"|"Professional Services"|"Real Estate and Construction"|"Retail"|"Software and Internet"|"Telecommunications"|"Transportation and Logistics"|"Travel"|"Wholesale and Distribution"|"Other",
          "WebsiteUrl": "string"
        },
        "Project": {
          "BusinessProblem": "string",
          "TargetCompletionDate": "string",
          "Title": "string"
        }
      }
    },
    "Type": "CustomerProject"
  }
  ...
]

--description (строка)

Предоставляет описание Engagement.

--title (строка)

Указывает заголовок Engagement.

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

Вывод

Arn -> (строка)

Amazon Resource Name (ARN), который идентифицирует вовлечение.

Id -> (строка)

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

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

Spec-Zone.ru

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