Spec-Zone.ru › AWS CLI v2

[ aws . marketplace-entitlement ]

получить-лицензии

Описание

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

Предупреждение

Параметр CustomerIdentifier планируется к устареванию. Используйте CustomerAWSAccountID вместо него.

Эти параметры взаимоисключающие. Вы не можете указать и CustomerIdentifier, и CustomerAWSAccountID в одном запросе.

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

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

Синтаксис

  get-entitlements
--product-code <value>
[--filter <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]

Параметры

--product-code (строка)

Код продукта используется для уникальной идентификации продукта в AWS Marketplace. Код продукта будет предоставлен AWS Marketplace при создании списка продукта.

--filter (массив)

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

CustomerIdentifier и CustomerAWSAccountID взаимоисключающие. Вы не можете указать оба в одном запросе.

ключ -> (строка)

значение -> (список)

(строка)

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

  KeyName1=string,string,KeyName2=string,string

Where valid key names are:
  CUSTOMER_IDENTIFIER
  DIMENSION
  CUSTOMER_AWS_ACCOUNT_ID

Синтаксис JSON:

{"CUSTOMER_IDENTIFIER"|"DIMENSION"|"CUSTOMER_AWS_ACCOUNT_ID": ["string", ...]
  ...}

--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.

Вывод

Лицензии -> (список)

Набор лицензий, найденных с помощью операции GetEntitlements. Если результат содержит пустой набор лицензий, NextToken все равно может быть присутствовать и должен использоваться.

(структура)

Лицензия представляет собой емкость продукта, принадлежащего клиенту. Например, клиент может владеть определенным количеством пользователей или мест в SaaS-приложении или определенным объемом емкости данных в многопользовательской базе данных.

КодПродукта -> (строка)

Код продукта, к которому относится данная лицензия. Коды продуктов предоставляются AWS Marketplace при создании списка продукта.

Измерение -> (строка)

Измерение, к которому относится данная лицензия. Измерения представляют категории емкости продукта и указываются при публикации продукта в AWS Marketplace.

ИдентификаторКлиента -> (строка)

Идентификатор клиента — это маркер каждого уникального клиента в приложении. Идентификаторы клиентов получаются с помощью операции ResolveCustomer в службе AWS Marketplace Metering Service.

IDУчетнойЗаписиAWSКлиента -> (строка)

Параметр CustomerAWSAccountID указывает ID учетной записи AWS покупателя.

Значение -> (структура)

EntitlementValue представляет собой количество емкости, на которую клиент имеет право для продукта.

ЦелоеЗначение -> (целое число)

Поле IntegerValue будет заполнено целым значением, когда лицензия является целого типа. В противном случае поле не будет установлено.

DoubleValue -> (двойное)

Поле DoubleValue будет заполнено двойным значением, когда лицензия является двойного типа. В противном случае поле не будет установлено.

BooleanValue -> (булево)

Поле BooleanValue будет заполнено булевым значением, когда лицензия является булева типа. В противном случае поле не будет установлено.

StringValue -> (строка)

Поле StringValue будет заполнено строковым значением, когда лицензия является строкового типа. В противном случае поле не будет установлено.

ДатаИстечения -> (метка времени)

Дата истечения срока действия представляет собой минимальную дату, до которой ожидается, что эта лицензия останется действительной. Для договорных продуктов, опубликованных в AWS Marketplace, дата истечения срока действия — это дата, на которую клиент обновит или аннулирует свой договор. Клиенты, которые выбирают продлить свой договор, по-прежнему будут иметь лицензии с датой истечения срока действия.

NextToken -> (строка)

Для результатов с постраничной навигацией используйте NextToken в последующих вызовах GetEntitlements. Если результат содержит пустой набор лицензий, NextToken все равно может быть присутствовать и должен использоваться.

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

Spec-Zone.ru

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