Spec-Zone.ru › AWS CLI v2

[ aws . configservice ]

describe-configuration-recorder-status

Описание

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

Для получения подробного статуса событий записи во времени добавьте свои события Config в метрики Amazon CloudWatch и используйте метрики CloudWatch.

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

Примечание

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

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

Синтаксис

  describe-configuration-recorder-status
[--configuration-recorder-names <value>]
[--service-principal <value>]
[--arn <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]

Параметры

--configuration-recorder-names (список)

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

Примечание

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

(строка)

Синтаксис:

"string" "string" ...

--service-principal (строка)

Для связанных с услугой регистраторов конфигурации можно использовать управляющий принцип связанной Amazon Web Services-службы для указания регистратора конфигурации.

--arn (строка)

Amazon Resource Name (ARN) регистратора конфигурации, который вы хотите указать.

--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
  • text
  • table
  • yaml
  • yaml-stream

--query (строка)

Запрос JMESPath для использования при фильтрации данных ответа.

--profile (строка)

Использовать определенный профиль из файла учетных данных.

--region (строка)

Область, которую использовать. Переопределяет настройки config/env.

--version (строка)

Отобразить версию этого инструмента.

--color (строка)

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

  • on
  • off
  • auto

--no-sign-request (булево)

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

--ca-bundle (строка)

Файл сертификатов CA для использования при проверке SSL-сертификатов. Переопределяет настройки config/env.

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

Примеры

Примечание

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

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

Получение статуса регистратора конфигурации

Следующая команда возвращает статус регистратора конфигурации по умолчанию:

aws configservice describe-configuration-recorder-status

Вывод:

{
    "ConfigurationRecordersStatus": [
        {
            "name": "default",
            "lastStatus": "SUCCESS",
            "recording": true,
            "lastStatusChangeTime": 1452193834.344,
            "lastStartTime": 1441039997.819,
            "lastStopTime": 1441039992.835
        }
    ]
}

Вывод

ConfigurationRecordersStatus -> (список)

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

(структура)

Текущий статус регистратора конфигурации.

Для получения подробного статуса событий записи во времени добавьте свои события Config в метрики CloudWatch и используйте метрики CloudWatch.

arn -> (строка)

Amazon Resource Name (ARN) регистратора конфигурации.

name -> (строка)

Имя регистратора конфигурации.

lastStartTime -> (временная метка)

Время последнего запуска регистратора.

lastStopTime -> (временная метка)

Время последней остановки регистратора.

recording -> (булево)

Указывает, записывает ли регистратор в данный момент.

lastStatus -> (строка)

Статус последнего события записи, обработанного регистратором.

lastErrorCode -> (строка)

Последний код ошибки, когда регистратор в последний раз потерпел неудачу.

lastErrorMessage -> (строка)

Последнее сообщение об ошибке, когда регистратор в последний раз потерпел неудачу.

lastStatusChangeTime -> (временная метка)

Время последнего изменения статуса события записи, обработанного регистратором.

servicePrincipal -> (строка)

Для связанных с услугой регистраторов конфигурации управляющий принцип связанной Amazon Web Services-службы.

Spec-Zone.ru

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