Spec-Zone.ru › AWS CLI v2

[ aws . partnercentral-selling ]

get-resource-snapshot

Описание

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

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

Синтаксис

  get-resource-snapshot
--catalog <value>
--engagement-identifier <value>
--resource-identifier <value>
--resource-snapshot-template-identifier <value>
--resource-type <value>
[--revision <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: извлекает снимок из производственной среды AWS.
  • Sandbox: извлекает снимок из среды песочницы, используемой для тестирования или разработки.

--engagement-identifier (строка)

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

--resource-identifier (строка)

Уникальный идентификатор конкретного ресурса, который был заснят. Формат и ограничения этого идентификатора зависят от указанного ResourceType. Для типа Opportunity это будет opportunity ID

--resource-snapshot-template-identifier (строка)

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

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

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

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

  • Opportunity

--revision (целое число)

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

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

--query (строка)

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

--profile (строка)

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

--region (строка)

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

--version (строка)

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

--color (строка)

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

  • on
  • off
  • auto

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

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

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

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

--cli-read-timeout (int)

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

--cli-connect-timeout (int)

Максимальное время подключения сокета в секундах. Если значение установлено в 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.

Вывод

Arn -> (строка)

Идентификатор ресурса Amazon (ARN), уникально определяющий снимок ресурса.

Catalog -> (строка)

Каталог, в котором был создан снимок. Соответствует каталогу, указанному в запросе.

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

Временная метка создания снимка в формате ISO 8601 (например, “2023-06-01T14:30:00Z”). Это позволяет точно отслеживать момент создания снимка.

CreatedBy -> (строка)

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

EngagementId -> (строка)

Идентификатор взаимодействия, связанного с этим снимком. Соответствует идентификатору взаимодействия, указанному в запросе.

Payload -> (структура помеченных объединений)

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

Примечание

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

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

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

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

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

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

StreetAddress -> (строка)

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

AwsAccountId -> (строка)

Указывает идентификатор учетной записи Amazon Web Services (AWS) Customer, связанный с Opportunity.

CompanyName -> (строка)

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

Duns -> (строка)

Указывает номер DUNS Customer, если он доступен.

Industry -> (строка)

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

OtherIndustry -> (строка)

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

WebsiteUrl -> (строка)

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

Contacts -> (список)

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

(структура)

Объект, содержащий контактные данные Customer Partner.

BusinessTitle -> (строка)

Должность (должность или роль) контактного лица партнера, связанная с Opportunity. BusinessTitle поддерживает либо PartnerAccountManager, либо OpportunityOwner.

Email -> (строка)

Электронный адрес контактного лица, связанный с Opportunity.

FirstName -> (строка)

Имя контактного лица, связанное с Opportunity.

LastName -> (строка)

Фамилия контактного лица, связанная с Opportunity.

Phone -> (строка)

Номер телефона контактного лица, связанный с Opportunity.

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

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

NextSteps -> (строка)

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

ReviewStatus -> (строка)

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

Stage -> (строка)

Определяет текущий этап возможности, предоставленной через снимок.

TargetCloseDate -> (строка)

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

OpportunityTeam -> (список)

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

(структура)

Объект, содержащий контактные данные Customer Partner.

BusinessTitle -> (строка)

Должность (должность или роль) контактного лица партнера, связанная с Opportunity. BusinessTitle поддерживает либо PartnerAccountManager, либо OpportunityOwner.

Email -> (строка)

Электронный адрес контактного лица, связанный с Opportunity.

FirstName -> (строка)

Имя контактного лица, связанное с Opportunity.

LastName -> (строка)

Фамилия контактного лица, связанная с Opportunity.

Phone -> (строка)

Номер телефона контактного лица, связанный с Opportunity.

OpportunityType -> (строка)

Указывает тип возможности.

PrimaryNeedsFromAws -> (список)

Определяет тип поддержки, необходимой партнеру от AWS.

(строка)

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

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

CustomerUseCase -> (строка)

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

DeliveryModels -> (список)

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

(строка)

ExpectedCustomerSpend -> (список)

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

(структура)

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

Amount -> (строка)

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

CurrencyCode -> (строка)

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

EstimationUrl -> (строка)

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

Frequency -> (строка)

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

TargetCompany -> (строка)

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

OtherSolutionDescription -> (строка)

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

SalesActivities -> (список)

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

(строка)

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

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

AwsMarketplaceOffers -> (список)

Принимает одно значение на возможность. Каждое значение — это Идентификатор ресурса Amazon (ARN) в этом формате: "offers": ["arn:aws:aws-marketplace:us-east-1:999999999999:AWSMarketplace/Offer/offer-sampleOffer32"].

Для получения списка предложений в связанной учетной записи продавца Маркета используйте действие ListEntities в API-интерфейсах каталога Маркета.

(строка)

AwsProducts -> (список)

Разрешает ассоциацию определенных продуктов Amazon Web Services с Opportunity. Партнеры могут указать соответствующие продукты Amazon Web Services для решения Opportunity и согласовать их с потребностями клиента. Возвращает несколько значений, разделенных запятыми. Например, "AWSProducts" : ["AmazonRedshift", "AWSAppFabric", "AWSCleanRooms"].

Используйте файл со списком продуктов Amazon Web Services, размещенных на GitHub: Продукты Amazon Web Services.

(строка)

Solutions -> (список)

Разрешает ассоциацию партнерских решений или предложений с возможностью. Для ассоциации решения укажите уникальный идентификатор решения, который можно получить с помощью операции ListSolutions.

Если конкретный идентификатор решения недоступен, можно использовать значение Other и предоставить подробную информацию о решении в поле otherSolutionOffered. Но когда возможность достигает стадии Committed или далее, значение Other не может быть использовано, и должен быть предоставлен действительный идентификатор решения.

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

(строка)

ResourceId -> (строка)

Идентификатор конкретного ресурса, для которого был создан снимок. Соответствует идентификатору ресурса, указанному в запросе.

ResourceSnapshotTemplateName -> (строка)

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

ResourceType -> (строка)

Тип ресурса, который был запечатлен. Соответствует ResourceType, указанному в запросе.

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

Номер версии этого снимка. Это положительное целое число, последовательное и уникальное в контексте представления ресурса.

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

Spec-Zone.ru

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