Spec-Zone.ru › AWS CLI v2

[ aws . docdb ]

describe-db-engine-versions

Описание

Возвращает список доступных движков.

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

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

Синтаксис

  describe-db-engine-versions
[--engine <value>]
[--engine-version <value>]
[--db-parameter-group-family <value>]
[--filters <value>]
[--default-only | --no-default-only]
[--list-supported-character-sets | --no-list-supported-character-sets]
[--list-supported-timezones | --no-list-supported-timezones]
[--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]

Параметры

--engine (строка)

Движок базы данных, который нужно вернуть.

--engine-version (строка)

Версия движка базы данных, которую нужно вернуть.

Пример: 3.6.0

--db-parameter-group-family (строка)

Имя конкретной семейства групп параметров для возврата подробных данных.

Ограничения:

  • При указании, должно соответствовать существующей DBParameterGroupFamily.

--filters (список)

В данный момент этот параметр не поддерживается.

(структура)

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

Подстановочные знаки в фильтрах не поддерживаются.

Name -> (строка)

Имя фильтра. Имена фильтров чувствительны к регистру.

Values -> (список)

Одно или несколько значений фильтра. Значения фильтров чувствительны к регистру.

(строка)

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

Name=string,Values=string,string ...

Синтаксис JSON:

[
  {
    "Name": "string",
    "Values": ["string", ...]
  }
  ...
]

--default-only | --no-default-only (логическое значение)

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

--list-supported-character-sets | --no-list-supported-character-sets (логическое значение)

Если этот параметр указан и запрашиваемый движок поддерживает параметр CharacterSetName для CreateDBInstance, в ответ включен список поддерживаемых наборов символов для каждой версии движка.

--list-supported-timezones | --no-list-supported-timezones (логическое значение)

Если этот параметр указан и запрашиваемый движок поддерживает параметр TimeZone для CreateDBInstance, в ответ включен список поддерживаемых часовых поясов для каждой версии движка.

--cli-input-json | --cli-input-yaml (строка) Читает аргументы из предоставленной строки JSON. Строка JSON следует формату, предоставленному --generate-cli-skeleton. Если на командной строке указаны другие аргументы, значения этих аргументов переопределят значения, предоставленные через JSON. Невозможно передать произвольные двоичные значения с помощью значения JSON, поскольку строка будет интерпретирована буквально. Это не может быть указано вместе с --cli-input-yaml.

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

Токен, указывающий, с какой точки следует начать постраничный вывод. Это NextToken из ранее усеченного ответа.

Примеры использования см. в разделе Постраничная навигация в Руководстве пользователя AWS CLI.

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

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

  • on
  • off
  • auto

--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-auto-prompt (логическое значение)

Автоматически запрашивать параметры ввода CLI.

--no-cli-auto-prompt (логическое значение)

Отключить автоматическое запроса параметров ввода CLI.

Примеры

Примечание

Чтобы использовать следующие примеры, необходимо установить и настроить AWS CLI. Подробнее см. руководство по началу работы в Руководстве пользователя AWS CLI.

Если не указано иное, все примеры используют правила цитирования в стиле Unix. Эти примеры необходимо адаптировать к правилам цитирования вашей терминальной оболочки. См. Использование кавычек со строками в Руководстве пользователя AWS CLI.

Для вывода списка доступных версий Amazon DocumentDB

Следующий describe-db-engine-versions пример выводит все доступные версии движка Amazon DocumentDB.

aws docdb describe-db-engine-versions \
    --engine docdb

Вывод:

{
    "DBEngineVersions": [
        {
            "DBEngineVersionDescription": "DocDB version 1.0.200837",
            "DBParameterGroupFamily": "docdb3.6",
            "EngineVersion": "3.6.0",
            "ValidUpgradeTarget": [],
            "DBEngineDescription": "Amazon DocumentDB (with MongoDB compatibility)",
            "SupportsLogExportsToCloudwatchLogs": true,
            "Engine": "docdb",
            "ExportableLogTypes": [
                "audit"
            ]
        }
    ]
}

Для получения дополнительной информации см. DescribeDBEngineVersions в Руководстве разработчика Amazon DocumentDB.

Вывод

Маркер -> (строка)

Необязательный маркер страницы, предоставленный предыдущим запросом. Если этот параметр указан, в ответе содержатся только записи после маркера, до значения, указанного в MaxRecords.

DBEngineVersions -> (список)

Подробная информация об одной или нескольких версиях движка.

(структура)

Подробная информация о версии движка.

Engine -> (строка)

Название базы данных движка.

EngineVersion -> (строка)

Номер версии базы данных движка.

DBParameterGroupFamily -> (строка)

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

DBEngineDescription -> (строка)

Описание базы данных движка.

DBEngineVersionDescription -> (строка)

Описание версии базы данных движка.

ValidUpgradeTarget -> (список)

Список версий движка, до которых можно выполнить обновление базы данных.

(структура)

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

Engine -> (строка)

Название движка базы данных, до которого можно выполнить обновление.

EngineVersion -> (строка)

Номер версии движка базы данных, до которого можно выполнить обновление.

Description -> (строка)

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

AutoUpgrade -> (булево)

Значение, указывающее, применяется ли целевая версия к любым исходным экземплярам базы данных, у которых AutoMinorVersionUpgrade установлено в true.

IsMajorVersionUpgrade -> (булево)

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

ExportableLogTypes -> (список)

Типы логов, доступные для экспорта базы данных движка в Amazon CloudWatch Logs.

(строка)

SupportsLogExportsToCloudwatchLogs -> (булево)

Значение, указывающее, поддерживает ли версия движка экспорт типов логов, указанных в ExportableLogTypes, в CloudWatch Logs.

SupportedCACertificateIdentifiers -> (список)

Список поддерживаемых идентификаторов сертификатов CA.

Дополнительную информацию можно найти в разделе Обновление сертификатов TLS Amazon DocumentDB и шифрование данных в процессе передачи в Руководстве разработчика Amazon DocumentDB.

(строка)

SupportsCertificateRotationWithoutRestart -> (булево)

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

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

Spec-Zone.ru

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