Spec-Zone.ru › AWS CLI v2

[ aws . partnercentral-selling ]

list-engagement-invitations

Описание

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

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

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

Синтаксис

  list-engagement-invitations
--catalog <value>
[--engagement-identifier <value>]
--participant-type <value>
[--payload-type <value>]
[--sender-aws-account-id <value>]
[--sort <value>]
[--status <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]

Параметры

--catalog (строка)

Указывает каталог, из которого нужно получить список приглашений на вовлечение. Используйте AWS для приглашений производства или Sandbox для тестовых сред.

--engagement-identifier (список)

Возвращает список сводок приглашений на вовлечение на основе заданных фильтров. Операция ListEngagementInvitations позволяет просматривать все отправленные или полученные вами приглашения. Вы должны указать ParticipantType, чтобы отфильтровать приглашения, где вы являетесь либо SENDER, либо RECEIVER. Приглашения автоматически истекают, если не приняты в течение 15 дней.

(строка)

Синтаксис:

"string" "string" ...

--participant-type (строка)

Указывает тип участника, для которого нужно получить список приглашений на вовлечение. Определяет роль участника.

Возможные значения:

  • SENDER
  • RECEIVER

--payload-type (список)

Определяет тип содержимого, связанного с приглашениями на вовлечение, которые нужно получить. Атрибуты в этом содержимом помогают принять или отклонить приглашение.

(строка)

Синтаксис:

"string" "string" ...

Where valid values are:
  OpportunityInvitation

--sender-aws-account-id (список)

Список идентификаторов учетных записей AWS отправителей для фильтрации приглашений.

(строка)

Синтаксис:

"string" "string" ...

--sort (структура)

Указывает параметры сортировки для получения списка приглашений на вовлечение. Приглашения можно сортировать по таким полям, как InvitationDate или Status, чтобы партнеры могли просматривать результаты в нужном порядке.

SortBy -> (строка)

Указывает поле, по которому сортируются приглашения на вовлечение. Типичные значения включают InvitationDate и Status.

SortOrder -> (строка)

Определяет порядок сортировки приглашений на вовлечение. Возможные значения: ASC (по возрастанию) или DESC (по убыванию).

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

SortBy=string,SortOrder=string

Синтаксис JSON:

{
  "SortBy": "InvitationDate",
  "SortOrder": "ASCENDING"|"DESCENDING"
}

--status (список)

Значения статуса для фильтрации приглашений.

(строка)

Синтаксис:

"string" "string" ...

Where valid values are:
  ACCEPTED
  PENDING
  REJECTED
  EXPIRED

--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
  • текст
  • таблица
  • yaml
  • yaml-поток

--query (строка)

Запрос JMESPath для фильтрации данных ответа.

--profile (строка)

Использовать определенный профиль из файла учетных данных.

--region (строка)

Регион для использования. Переопределяет настройки конфигурации/окружения.

--version (строка)

Отобразить версию этого инструмента.

--color (строка)

Включить/выключить цветной вывод.

  • включено
  • выключено
  • автоматически

--no-sign-request (булево)

Не подписывать запросы. Учетные данные не будут загружены, если этот аргумент предоставлен.

--ca-bundle (строка)

Файл сертификата корневого центра для проверки SSL-сертификатов. Переопределяет настройки конфигурации/окружения.

--cli-read-timeout (целое число)

Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет блокирующим и не будет ограничено по времени. Значение по умолчанию — 60 секунд.

--cli-connect-timeout (целое число)

Максимальное время подключения сокета в секундах. Если значение установлено в 0, подключение сокета будет блокирующим и не будет ограничено по времени. Значение по умолчанию — 60 секунд.

--cli-binary-format (строка)

Стиль форматирования для двоичных блоков. Формат по умолчанию — base64. Формат base64 ожидает, что двоичные блоки будут предоставлены как закодированная в base64 строка. Формат raw-in-base64-out сохраняет совместимость с поведением AWS CLI версии 1, а двоичные значения должны передаваться буквально. При предоставлении содержимого из файла, которое сопоставляется с двоичным блоком, 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.

Вывод

EngagementInvitationSummaries -> (список)

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

(структура)

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

Arn -> (строка)

Amazon Resource Name (ARN) приглашения на участие. ARN — это уникальный идентификатор, который позволяет партнёрам ссылаться на приглашение в своей системе и управлять его жизненным циклом.

Catalog -> (строка)

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

EngagementId -> (строка)

Идентификатор участия, связанного с этим приглашением. Это связывает приглашение с его родительским участием.

EngagementTitle -> (строка)

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

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

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

Id -> (строка)

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

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

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

ParticipantType -> (строка)

Определяет роль вызывающего лица в приглашении на участие.

PayloadType -> (строка)

Описывает тип данных, связанных с приглашением на участие, такой как Opportunity или MarketplaceOffer. Это помогает партнёрам понять характер запроса на участие от AWS.

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

Указывает компанию-партнёра или лицо, получившее приглашение на участие. Это поле важно для отслеживания того, кому было направлено приглашение в рамках организации партнёра.

Примечание

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

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

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

Alias -> (строка)

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

AwsAccountId -> (строка)

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

SenderAwsAccountId -> (строка)

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

SenderCompanyName -> (строка)

Указывает имя компании или подразделения AWS, отправившего приглашение на участие. Эта информация полезна для партнёров, чтобы знать, какая часть AWS запрашивает участие.

Status -> (строка)

Представляет текущий статус приглашения на участие, такой как Pending, Accepted или Rejected. Статус помогает отслеживать прогресс и ответ на приглашение.

NextToken -> (строка)

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

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

Spec-Zone.ru

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