describe-agreement

Описание

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

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

Синтаксис

  describe-agreement
--agreement-id <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]

Параметры

--agreement-id (строка)

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

--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
текст
таблица
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 версии 1, и двоичные значения должны передаваться буквально. При предоставлении содержимого из файла, сопоставляемого с двоичным блоком, 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.

Вывод

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

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

Примечание

AcceptanceTime и StartTime могут отличаться для соглашений с будущей датой (FDA).

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

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

accountId -> (строка)

AWS идентификатор учетной записи получателя.

agreementId -> (строка)

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

agreementType -> (строка)

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

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

Дата и время окончания соглашения. Поле не заполнено для соглашений pay-as-you-go, которые не имеют дат окончания.

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

Оценочная стоимость соглашения.

agreementValue -> (строка)

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

Примечание

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

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

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

Это 0, если принятые условия содержат UsageBasedPricingTerm без ConfigurableUpfrontPricingTerm или RecurringPaymentTerm. Это происходит при ценообразовании на основе использования (например, SaaS с измерением или AMI/контейнерные почасовые или ежемесячные), потому что точное использование неизвестно заранее.

currencyCode -> (строка)

Определяет код валюты для платы.

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

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

offerId -> (строка)

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

resources -> (список)

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

(структура)

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

id -> (строка)

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

Примечание

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

type -> (строка)

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

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

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

accountId -> (строка)

AWS идентификатор учетной записи предлагающей стороны.

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

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

status -> (строка)

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

Статусы включают:

ACTIVE – Условия соглашения активны.
ARCHIVED – Соглашение закончилось без указанной причины.
CANCELLED – Принимающая сторона прекратила соглашение до установленной даты окончания.
EXPIRED – Соглашение закончилось в установленную дату окончания.
RENEWED – Соглашение было продлено в новое соглашение (например, автоматическое продление).
REPLACED – Соглашение было заменено с помощью предложения по замене соглашения.
ROLLED_BACK (только для неактивных пересмотров соглашения) – Пересмотр соглашения отменен из-за ошибки. Теперь активен предыдущий пересмотр.
SUPERCEDED (только для неактивных пересмотров соглашения) – Пересмотр соглашения больше не активен, и теперь активен другой пересмотр соглашения.
TERMINATED – Соглашение закончилось до установленной даты окончания из-за завершения AWS (например, из-за проблем с оплатой).