Spec-Zone.ru › AWS CLI v2

[ aws . rds ]

describe-pending-maintenance-actions

Описание

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

Этот API следует модели событийной согласованности. Это означает, что результат команды DescribePendingMaintenanceActions может не быть немедленно виден всем последующим командам RDS. Имейте это в виду, когда вы используете DescribePendingMaintenanceActions сразу после использования предыдущей команды API, такой как ApplyPendingMaintenanceActions.

См. также: AWS API Documentation

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

Синтаксис

  describe-pending-maintenance-actions
[--resource-identifier <value>]
[--filters <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]

Параметры

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

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

--filters (список)

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

Поддерживаемые фильтры:

  • db-cluster-id — Принимает идентификаторы кластеров баз данных и Amazon Resource Names (ARN) кластеров баз данных. Список результатов содержит только ожидающие действия по техническому обслуживанию для кластеров баз данных, определенных этими ARN.
  • db-instance-id — Принимает идентификаторы экземпляров баз данных и Amazon Resource Names (ARN) экземпляров баз данных. Список результатов содержит только ожидающие действия по техническому обслуживанию для экземпляров баз данных, определенных этими ARN.

(структура)

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

Примечание

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

Следующие действия могут быть отфильтрованы:

  • DescribeDBClusterBacktracks
  • DescribeDBClusterEndpoints
  • DescribeDBClusters
  • DescribeDBInstances
  • DescribeDBRecommendations
  • DescribeDBShardGroups
  • DescribePendingMaintenanceActions

Имя -> (строка)

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

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

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

(строка)

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

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

Синтаксис JSON:

[
  {
    "Name": "string",
    "Values": ["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
  • 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.

Примеры

Примечание

Для использования следующих примеров необходимо установить и настроить AWS CLI. См. руководство по началу работы в Руководстве пользователя AWS CLI для получения дополнительной информации.

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

Для перечисления ресурсов с как минимум одним ожидающим действием по техническому обслуживанию

Следующий пример describe-pending-maintenance-actions перечисляет ожидающее действие по техническому обслуживанию для экземпляра БД.

aws rds describe-pending-maintenance-actions

Вывод:

{
    "PendingMaintenanceActions": [
        {
            "ResourceIdentifier": "arn:aws:rds:us-west-2:123456789012:cluster:global-db1-cl1",
            "PendingMaintenanceActionDetails": [
                {
                    "Action": "system-update",
                    "Description": "Upgrade to Aurora PostgreSQL 2.4.2"
                }
            ]
        }
    ]
}

Дополнительную информацию см. в разделе Поддержание экземпляра базы данных в Руководстве пользователя Amazon RDS.

Вывод

PendingMaintenanceActions -> (список)

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

(структура)

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

ResourceIdentifier -> (строка)

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

PendingMaintenanceActionDetails -> (список)

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

(структура)

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

Action -> (строка)

Тип запланированного действия технического обслуживания, доступного для ресурса.

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

Допустимые значения:

  • ca-certificate-rotation
  • db-upgrade
  • hardware-maintenance
  • os-upgrade
  • system-update

Дополнительную информацию об этих действиях см. в разделах Действия технического обслуживания для Amazon Aurora или Действия технического обслуживания для Amazon RDS .

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

Дата окна технического обслуживания, когда действие будет применено. Действие технического обслуживания применяется к ресурсу во время первого окна технического обслуживания после этой даты.

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

Дата, когда действие технического обслуживания будет автоматически применено.

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

OptInStatus -> (строка)

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

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

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

Description -> (строка)

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

Marker -> (строка)

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

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

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

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