Spec-Zone.ru › AWS CLI v2

[ aws . marketplace-agreement ]

Поиск соглашений

Описание

Ищет все соглашения, которые у предлагающего или принимающего есть в AWS Marketplace. Поиск возвращает список соглашений с основной информацией о соглашении.

Поддерживаются следующие комбинации фильтров:

  • PartyType в качестве Proposer + AgreementType + ResourceIdentifier
  • PartyType в качестве Proposer + AgreementType + OfferId
  • PartyType в качестве Proposer + AgreementType + AcceptorAccountId
  • PartyType в качестве Proposer + AgreementType + Status
  • PartyType в качестве Proposer + AgreementType + ResourceIdentifier + Status
  • PartyType в качестве Proposer + AgreementType + OfferId + Status
  • PartyType в качестве Proposer + AgreementType + AcceptorAccountId + Status
  • PartyType в качестве Proposer + AgreementType + ResourceType + Status
  • PartyType в качестве Proposer + AgreementType + AcceptorAccountId + ResourceType + Status
  • PartyType в качестве Proposer + AgreementType + AcceptorAccountId + OfferId
  • PartyType в качестве Proposer + AgreementType + AcceptorAccountId + OfferId + Status
  • PartyType в качестве Proposer + AgreementType + AcceptorAccountId + ResourceIdentifier
  • PartyType в качестве Proposer + AgreementType + AcceptorAccountId + ResourceIdentifier + Status
  • PartyType в качестве Proposer + AgreementType + AcceptorAccountId + ResourceType

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

Синтаксис

  search-agreements
[--catalog <value>]
[--filters <value>]
[--max-results <value>]
[--next-token <value>]
[--sort <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 (строка)

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

--filters (список)

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

Поддерживаются следующие фильтры:

  • ResourceIdentifier – Уникальный идентификатор ресурса.
  • ResourceType – Тип ресурса, который является продуктом (AmiProduct , ContainerProduct или SaaSProduct).
  • PartyType – Тип стороны (либо Acceptor или Proposer) вызывающей стороны. Для соглашений, где вызывающей стороной является предлагающий, используйте фильтр Proposer. Для соглашений, где вызывающей стороной является принимающий, используйте фильтр Acceptor.
  • AcceptorAccountId – AWS идентификатор учетной записи стороны, принимающей условия соглашения.
  • OfferId – Уникальный идентификатор предложения, в котором условия зарегистрированы в марке соглашения.
  • Status – Текущий статус соглашения. Значения включают в себя ACTIVE, ARCHIVED, CANCELLED, EXPIRED, RENEWED, REPLACED и TERMINATED.
  • BeforeEndTime – Дата для фильтрации соглашений с датой до endTime соглашения.
  • AfterEndTime – Дата для фильтрации соглашений с датой после endTime соглашения.
  • AgreementType – Тип соглашения. Значения включают PurchaseAgreement или VendorInsightsAgreement.

(структура)

Пара пары имя фильтра и значение, которая используется для возвращения более конкретного списка результатов. Фильтры могут использоваться для сопоставления набора ресурсов по различным критериям, таким как offerId или productId.

name -> (строка)

Имя фильтра.

values -> (список)

Значение фильтра.

(строка)

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

name=string,values=string,string ...

JSON синтаксис:

[
  {
    "name": "string",
    "values": ["string", ...]
  }
  ...
]

--max-results (целое число)

Максимальное количество соглашений для возврата в ответе.

--next-token (строка)

Токен для указания места начала постраничной навигации.

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

Объект, содержащий атрибуты SortBy и SortOrder.

sortBy -> (строка)

Атрибут, по которому данные сгруппированы, которые могут быть по StartTime и EndTime. Значение по умолчанию - EndTime.

sortOrder -> (строка)

Порядок сортировки, который может быть ASCENDING или DESCENDING. Значение по умолчанию - DESCENDING.

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

sortBy=string,sortOrder=string

JSON синтаксис:

{
  "sortBy": "string",
  "sortOrder": "ASCENDING"|"DESCENDING"
}

--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
  • таблица
  • 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.

Вывод

agreementViewSummaries -> (список)

Резюме соглашения, включая атрибуты верхнего уровня (например, идентификатор соглашения, версия, предлагающий и принимающий).

(структура)

Резюме соглашения, включая атрибуты верхнего уровня (например, идентификатор соглашения, версия, предлагающий и принимающий).

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

Дата и время принятия соглашения.

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

Подробности стороны, принимающей условия соглашения. Обычно это покупатель для PurchaseAgreement.

accountId -> (строка)

Идентификатор AWS-аккаунта принимающего.

agreementId -> (строка)

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

agreementType -> (строка)

Тип соглашения. Значения — PurchaseAgreement или VendorInsightsAgreement.

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

Дата и время окончания соглашения. Поле является null для соглашений по принципу оплаты по факту, у которых нет даты окончания.

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

Резюме предложения

offerId -> (строка)

Уникальный идентификатор предложения в AWS Marketplace.

resources -> (список)

Список ресурсов, участвующих в соглашении.

(структура)

Список ресурсов, участвующих в соглашении.

id -> (строка)

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

Примечание

Мы используем термин «ресурс», который чаще всего является продуктом, поэтому resourceId также является productId.

type -> (строка)

Тип ресурса, который является продуктом. Значения включают SaaSProduct или AmiProduct.

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

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

accountId -> (строка)

Идентификатор AWS-аккаунта предлагающего.

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

Дата и время начала соглашения.

status -> (строка)

Текущий статус соглашения.

nextToken -> (строка)

Токен, используемый для пагинации. Поле является null, если больше результатов нет.

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

Spec-Zone.ru

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