Spec-Zone.ru › AWS CLI v2

[ aws . partnercentral-selling ]

list-opportunities

Описание

Этот запрос принимает список фильтров для получения подмножеств возможностей, а также параметры сортировки. Эта функция доступна партнерам из Partner Central, используя действие API ListOpportunities.

Для синхронизации вашей системы с Amazon Web Services, перечисляйте только возможности, которые были недавно созданы или обновлены. Рекомендуется полагаться на события, генерируемые службой в стандартной очереди событий Amazon EventBridge вашей учетной записи Amazon Web Services, также можно использовать действие ListOpportunities.

Рекомендуется следующий подход:

  • Найдите последний LastModifiedDate, который вы сохранили, и используйте только значения, полученные из Amazon Web Services. Не используйте значения, сгенерированные вашей системой.
  • При отправке запроса ListOpportunities, отправьте дату в формате ISO 8601 в фильтре AfterLastModifiedDate.
  • Amazon Web Services вернёт только возможности, созданные или обновленные на или после этой даты и времени. Используйте NextToken для итерации по всем страницам.

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

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

Синтаксис

  list-opportunities
--catalog <value>
[--customer-company-name <value>]
[--identifier <value>]
[--last-modified-date <value>]
[--life-cycle-review-status <value>]
[--life-cycle-stage <value>]
[--sort <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. Каталог определяет, в какой среде отображаются возможности. Используйте AWS для отображения реальных возможностей в каталоге Amazon Web Services и Sandbox для тестирования в безопасных, изолированных средах.

--customer-company-name (список)

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

(строка)

Синтаксис:

"string" "string" ...

--identifier (список)

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

(строка)

Синтаксис:

"string" "string" ...

--last-modified-date (структура)

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

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

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

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

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

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

AfterLastModifiedDate=timestamp,BeforeLastModifiedDate=timestamp

Синтаксис JSON:

{
  "AfterLastModifiedDate": timestamp,
  "BeforeLastModifiedDate": timestamp
}

--life-cycle-review-status (список)

Фильтрует возможности на основе текущего статуса утверждения жизненного цикла. Используйте этот фильтр, чтобы получить возможности со статусами, такими как Pending Submission, In Review, Action Required или Approved.

(строка)

Синтаксис:

"string" "string" ...

Where valid values are:
  Pending Submission
  Submitted
  In review
  Approved
  Rejected
  Action Required

--life-cycle-stage (список)

Фильтрует возможности на основе стадии жизненного цикла. Этот фильтр позволяет партнерам получить возможности на разных стадиях цикла продаж, таких как Qualified, Technical Validation, Business Validation или Closed Won.

(строка)

Синтаксис:

"string" "string" ...

Where valid values are:
  Prospect
  Qualified
  Technical Validation
  Business Validation
  Committed
  Launched
  Closed Lost

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

Объект, определяющий способ сортировки ответа. Значение по умолчанию Sort.SortBy — LastModifiedDate.

SortBy -> (строка)

Имя поля для сортировки.

SortOrder -> (строка)

Порядок сортировки.

По умолчанию: Descending

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

SortBy=string,SortOrder=string

Синтаксис JSON:

{
  "SortBy": "LastModifiedDate"|"Identifier"|"CustomerCompanyName",
  "SortOrder": "ASCENDING"|"DESCENDING"
}

--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
  • text
  • table
  • yaml
  • yaml-stream

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

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

OpportunitySummaries -> (список)

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

(структура)

Объект, содержащий подмножество полей Opportunity.

Arn -> (строка)

Идентификатор ресурса Amazon (ARN) для возможности. Этот глобально уникальный идентификатор может использоваться для политик IAM и кросс-сервисных ссылок.

Catalog -> (строка)

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

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

DateTime когда Opportunity был последним создан.

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

Объект, содержащий детали клиента Opportunity.

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

Объект, содержащий детали учетной записи клиента.

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

Указывает адресные данные конечного Customer, связанные с Opportunity.

City -> (строка)

Указывает город конечного Customer, связанный с Opportunity.

CountryCode -> (строка)

Указывает страну конечного Customer, связанную с Opportunity.

PostalCode -> (строка)

Указывает почтовый индекс конечного Customer, связанный с Opportunity.

StateOrRegion -> (строка)

Указывает штат или регион конечного Customer, связанный с Opportunity.

Допустимые значения: Alabama | Alaska | American Samoa | Arizona | Arkansas | California | Colorado | Connecticut | Delaware | Dist. of Columbia | Federated States of Micronesia | Florida | Georgia | Guam | Hawaii | Idaho | Illinois | Indiana | Iowa | Kansas | Kentucky | Louisiana | Maine | Marshall Islands | Maryland | Massachusetts | Michigan | Minnesota | Mississippi | Missouri | Montana | Nebraska | Nevada | New Hampshire | New Jersey | New Mexico | New York | North Carolina | North Dakota | Northern Mariana Islands | Ohio | Oklahoma | Oregon | Palau | Pennsylvania | Puerto Rico | Rhode Island | South Carolina | South Dakota | Tennessee | Texas | Utah | Vermont | Virginia | Virgin Islands | Washington | West Virginia | Wisconsin | Wyoming | APO/AE | AFO/FPO | FPO, AP

CompanyName -> (строка)

Указывает название компании конечного Customer, связанное с Opportunity.

Industry -> (строка)

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

Для отправки значения за пределами списка используйте Other.

Условно обязательно, если Other выбрано для вертикали отрасли в LOV.

OtherIndustry -> (строка)

Указывает отрасль конечного Customer, связанную с Opportunity, когда выбранное значение в поле Industry равно Other. Это поле актуально, когда отрасль клиента не попадает в предопределенные значения списка и требует пользовательского описания.

WebsiteUrl -> (строка)

Указывает URL-адрес веб-сайта компании конечного клиента, связанного с Opportunity. Это значение имеет решающее значение для сопоставления клиента в системе CRM Amazon Web Services.

Id -> (строка)

Только для чтения, сгенерированный системой уникальный идентификатор Opportunity.

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

DateTime когда Opportunity был последним изменён.

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

Объект, содержащий сведения о жизненном цикле Opportunity.

ClosedLostReason -> (строка)

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

NextSteps -> (строка)

Указывает предстоящие действия или задачи для Opportunity. Это поле используется для передачи Amazon Web Services следующих действий, необходимых для Opportunity.

ReviewComments -> (строка)

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

ReviewStatus -> (строка)

Указывает статус проверки возможности, переданной партнёром. Это поле только для чтения и применимо только к ссылкам партнёров. Допустимые значения:

  • Ожидание отправки: Не отправлено на проверку (редактируется).
  • Отправлено: Отправлено на проверку и ещё не проверено Amazon Web Services (только для чтения).
  • На проверке: Проходит проверку Amazon Web Services (только для чтения).
  • Требуется действие: Устраните любые проблемы, отмеченные Amazon Web Services. Используйте действие API UpdateOpportunity для обновления возможности и убедитесь, что внесли все необходимые изменения. Только эти поля подлежат редактированию, когда Lifecycle.ReviewStatus находится в состоянии Action Required :
    • Customer.Account.Address.City
    • Customer.Account.Address.CountryCode
    • Customer.Account.Address.PostalCode
    • Customer.Account.Address.StateOrRegion
    • Customer.Account.Address.StreetAddress
    • Customer.Account.WebsiteUrl
    • LifeCycle.TargetCloseDate
    • Project.ExpectedCustomerSpend.Amount
    • Project.ExpectedCustomerSpend.CurrencyCode
    • Project.CustomerBusinessProblem
    • PartnerOpportunityIdentifier

После обновлений возможность вновь попадает в фазу проверки. Этот процесс повторяется до тех пор, пока все проблемы не будут устранены, и статус Lifecycle.ReviewStatus не будет установлен в Approved или Rejected.

  • Утверждено: Проверено и переведено в пайплайн продавца Amazon Web Services (редактируется).
  • Отклонено: Дисквалифицировано (только для чтения).

ReviewStatusReason -> (строка)

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

Stage -> (строка)

Указывает текущую стадию жизненного цикла Opportunity, которая отображается в этапах Amazon Web Services из текущей стадии в CRM партнера. Это поле предоставляет переведённое значение стадии и даёт представление о прогрессе Opportunity в цикле продаж в соответствии с определениями Amazon Web Services.

Примечание

Лид и перспективный клиент должны быть дополнительно развиты до возможности Qualified, прежде чем отправлять заявку. Возможности, которые были закрыты/потеряны до отправки, не подходят для отправки.

Описание каждой стадии продаж:

  • Перспективный клиент: Amazon Web Services определяет возможность. Она может быть активной (поступает непосредственно от конечного клиента через лид) или латентной (команда вашего аккаунта считает, что она существует на основе исследований, планов аккаунта, сценариев продаж).
  • Квалифицированный: Команда вашего аккаунта взаимодействовала с клиентом, чтобы обсудить жизнеспособность и понять требования. Клиент согласился с тем, что возможность реальна, интересна и может решить бизнес/технические потребности.
  • Техническая валидация: Все стороны понимают план реализации.
  • Бизнес-валидация: Была предложена цена, и все стороны согласны с шагами для закрытия.
  • Зафиксировано: Клиент подписал контракт, но Amazon Web Services ещё не начал выставление счетов.
  • Запущено: Рабочая нагрузка завершена, и Amazon Web Services начал выставление счетов.
  • Закрыто, потеряно: Возможность потеряна, и нет шагов для продвижения.

TargetCloseDate -> (строка)

Указывает дату, когда Amazon Web Services ожидает начала значительного выставления счетов, завершения проекта и перехода в производство. Это поле информирует продавца Amazon Web Services о том, когда возможность запускается и начинает генерировать использование Amazon Web Services.

Убедитесь, что Target Close Date не в прошлом.

OpportunityType -> (строка)

Указывает тип возможности как возобновление, новый или расширение.

Типы возможностей:

  • Новая возможность: Представляет новую бизнес-возможность с потенциальным клиентом, который ранее не взаимодействовал с вашими решениями или услугами.
  • Возможность возобновления: Представляет возможность возобновить действующий контракт или подписку с текущим клиентом, обеспечивая непрерывность обслуживания.
  • Возможность расширения: Представляет возможность расширить сферу действия действующего контракта или подписки, добавив новые услуги или увеличив объём существующих услуг для текущего клиента.

PartnerOpportunityIdentifier -> (строка)

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

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

Объект, содержащий сводку деталей проекта Opportunity.

DeliveryModels -> (список)

Указывает модель развертывания или потребления вашего решения или услуги в контексте Opportunity. Вы можете выбрать несколько вариантов.

Описание вариантов из поля Delivery Model:

  • SaaS или PaaS: Ваше решение на основе Amazon Web Services, развернутое как SaaS или PaaS в вашей среде Amazon Web Services.
  • BYOL или AMI: Ваше решение на основе Amazon Web Services, развернутое как BYOL или AMI в среде Amazon Web Services конечного клиента.
  • Управляемые услуги: Управление бизнесом Amazon Web Services конечного клиента (например: Консультации, дизайн, реализация, поддержка выставления счетов, оптимизация затрат, техническая поддержка).
  • Профессиональные услуги: Предложения для помощи крупным конечным клиентам в достижении конкретных бизнес-результатов для принятия облачных решений (например, консультации или планирование трансформации).
  • Реселлер: Учёт и выставление счетов Amazon Web Services для ваших клиентов.
  • Другие: Модель доставки, не описанная выше.

(строка)

ExpectedCustomerSpend -> (список)

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

(структура)

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

Amount -> (строка)

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

CurrencyCode -> (строка)

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

EstimationUrl -> (строка)

Ссылка, предоставляющая дополнительную информацию или контекст об оценке расходов.

Frequency -> (строка)

Указывает, с какой частотой клиент, как ожидается, будет тратить прогнозируемую сумму. Это может включать значения, такие как Monthly, Quarterly или Annually. Значение по умолчанию — Monthly, представляющее ежемесячные повторяющиеся расходы.

TargetCompany -> (строка)

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

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

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

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