Spec-Zone.ru › AWS CLI v2

[ aws . partnercentral-selling ]

Задачи принятия приглашения на участие в работе

Описание

Перечисляет все задачи StartEngagementByAcceptingInvitationTask, находящиеся в процессе выполнения, завершенные или завершившиеся с ошибкой, которые были инициированы учетной записью вызывающего пользователя.

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

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

Синтаксис

  list-engagement-by-accepting-invitation-tasks
--catalog <value>
[--engagement-invitation-identifier <value>]
[--opportunity-identifier <value>]
[--sort <value>]
[--task-identifier <value>]
[--task-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: Получает запрос из рабочей среды AWS.
  • Sandbox: Получает запрос из тестовой среды, используемой для целей тестирования или разработки.

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

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

(строка)

Синтаксис:

"string" "string" ...

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

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

(строка)

Синтаксис:

"string" "string" ...

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

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

SortBy -> (строка)

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

SortOrder -> (строка)

Определяет порядок представления отсортированных результатов.

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

SortBy=string,SortOrder=string

Синтаксис JSON:

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

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

Фильтрует задачи по их уникальным идентификаторам. Используйте это, когда нужно получить информацию о конкретных задачах.

(строка)

Синтаксис:

"string" "string" ...

--task-status (список)

Фильтрует задачи по их текущему статусу. Это позволяет сфокусироваться на задачах в определенных состояниях.

(строка)

Синтаксис:

"string" "string" ...

Where valid values are:
  IN_PROGRESS
  COMPLETE
  FAILED

--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 (строка)

Образ 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.

Вывод

NextToken -> (строка)

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

TaskSummaries -> (список)

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

(структура)

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

EngagementInvitationId -> (строка)

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

Message -> (строка)

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

OpportunityId -> (строка)

Уникальный идентификатор возможности, которая была создана.

ReasonCode -> (строка)

Код, указывающий на конкретную причину ошибки.

ResourceSnapshotJobId -> (строка)

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

StartTime -> (маркировка времени)

Отметка времени начала задачи.

TaskArn -> (строка)

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

TaskId -> (строка)

Уникальный идентификатор задачи.

TaskStatus -> (строка)

Статус задачи.

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

Spec-Zone.ru

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