Spec-Zone.ru › AWS CLI v2

[ aws . docdb ]

Действия ожидающего обслуживания

Описание

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

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

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

(структура)

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

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

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

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

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

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

(строка)

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

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

Примеры

Примечание

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

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

Чтобы отобразить действия ожидающего обслуживания Amazon DocumentDB

Следующий describe-pending-maintenance-actions пример отображает все ваши действия ожидающего обслуживания Amazon DocumentDB.

aws docdb describe-pending-maintenance-actions

Вывод:

{
    "PendingMaintenanceActions": []
}

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

Вывод

PendingMaintenanceActions -> (список)

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

(структура)

Представляет вывод операции ApplyPendingMaintenanceAction.

ResourceIdentifier -> (строка)

Amazon Resource Name (ARN) ресурса, для которого имеются действия ожидающего обслуживания.

PendingMaintenanceActionDetails -> (список)

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

(структура)

Предоставляет сведения о действии ожидающего обслуживания для ресурса.

Action -> (строка)

Тип действия ожидающего обслуживания, доступного для ресурса.

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

Дата окна обслуживания, когда действие применяется. Действие обслуживания применяется к ресурсу в течение его первого окна обслуживания после этой даты. Если эта дата указана, все запросы next-maintenance игнорируются.

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

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

OptInStatus -> (строка)

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

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

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

Description -> (строка)

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

Marker -> (строка)

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

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

Spec-Zone.ru

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