Spec-Zone.ru › AWS CLI v2

[ aws . partnercentral-selling ]

получить-участие

Описание

Используйте этот параметр для получения записи об участии для заданного EngagementIdentifier.

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

Синтаксис

  get-engagement
--catalog <value>
--identifier <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 (строка)

Указывает каталог, связанный с запросом об участии. Допустимые значения — AWS и Sandbox.

--identifier (строка)

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

--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
  • текст
  • таблица
  • 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-auto-prompt (булево)

Автоматически запрашивать параметры ввода CLI.

--no-cli-auto-prompt (булево)

Отключить автоматическое запроса параметров ввода CLI.

Вывод

Arn -> (строка)

Amazon Resource Name (ARN) извлеченного участия.

Contexts -> (список)

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

(структура)

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

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

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

Примечание

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

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

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

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

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

CompanyName -> (строка)

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

CountryCode -> (строка)

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

Industry -> (строка)

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

WebsiteUrl -> (строка)

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

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

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

BusinessProblem -> (строка)

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

TargetCompletionDate -> (строка)

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

Title -> (строка)

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

Type -> (строка)

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

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

Дата и время создания участия в формате ISO 8601 (UTC). Например: «2023-05-01T20:37:46Z». Эта метка времени помогает отслеживать жизненный цикл участия.

CreatedBy -> (строка)

AWS-идентификатор учетной записи пользователя, который первоначально создал участие. Это поле помогает отслеживать происхождение участия.

Description -> (строка)

Более подробное описание участия. Это предоставляет дополнительный контекст или информацию о цели или объеме участия.

Id -> (строка)

Уникальный идентификатор ресурса извлеченного участия.

MemberCount -> (целое число)

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

Title -> (строка)

Название участия. Оно предоставляет краткое описательное имя для участия, которое является понятным и легко узнаваемым.

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

Spec-Zone.ru

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