Spec-Zone.ru › AWS CLI v2

[ aws . partnercentral-selling ]

list-engagement-from-opportunity-tasks

Описание

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

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

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

Синтаксис

  list-engagement-from-opportunity-tasks
--catalog <value>
[--engagement-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-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 -> (список)

TaskSummaries Массив объектов TaskSummary, содержащих подробности о каждой задаче.

(структура)

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

EngagementId -> (строка)

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

EngagementInvitationId -> (строка)

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

Message -> (строка)

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

OpportunityId -> (строка)

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

ReasonCode -> (строка)

Код, указывающий конкретную причину сбоя задачи. Это поле заполняется, когда статус задачи — FAILED, и содержит категоризированную причину сбоя.

ResourceSnapshotJobId -> (строка)

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

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

Метка времени, указывающая момент инициирования задачи в формате RFC 3339 5.6 date-time.

TaskArn -> (строка)

Идентификатор ресурса Amazon (ARN), уникально определяющий эту задачу в AWS. Этот ARN можно использовать для ссылки на задачу в других службах или API AWS.

TaskId -> (строка)

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

TaskStatus -> (строка)

Текущий статус задачи.

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

Spec-Zone.ru

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