Spec-Zone.ru › AWS CLI v2

[ aws . ssm ]

get-calendar-state

Описание

Получает состояние календаря изменений Amazon Web Services Systems Manager в текущее время или в указанное время. Если вы укажете время, GetCalendarState возвращает состояние календаря в это конкретное время и возвращает следующее время, когда состояние календаря изменений изменится. Если вы не укажете время, GetCalendarState использует текущее время. Записи календаря изменений могут иметь два возможных состояния: OPEN или CLOSED.

Если вы укажете более одного календаря в запросе, команда возвращает статус OPEN только если все календари в запросе открыты. Если один или несколько календарей в запросе закрыты, возвращаемый статус — CLOSED.

Дополнительную информацию о календаре изменений, инструменте Amazon Web Services Systems Manager, см. в разделе «Календарь изменений Amazon Web Services Systems Manager» в руководстве пользователя Amazon Web Services Systems Manager.

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

Синтаксис

  get-calendar-state
--calendar-names <value>
[--at-time <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]

Параметры

--calendar-names (список)

Имена Amazon Resource Names (ARN) документов Systems Manager (документы SSM), представляющих записи календаря, для которых нужно получить состояние.

(строка)

Синтаксис:

"string" "string" ...

--at-time (строка)

(Необязательно) Конкретное время, для которого требуется информация о состоянии календаря, в формате ISO 8601. Если вы не укажете значение или AtTime, будет использовано текущее время.

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

Переопределить адрес по умолчанию команды заданным адресом.

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

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

  • включено
  • выключено
  • автоматически

--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 для вывода.

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

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

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

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

Примеры

Примечание

Чтобы использовать следующие примеры, необходимо установить и настроить AWS CLI. Дополнительную информацию см. в руководстве «Начало работы» в руководстве пользователя AWS CLI.

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

Пример 1: Получение текущего состояния календаря изменений

Этот get-calendar-state пример возвращает состояние календаря в текущее время. Поскольку в примере не указано время, сообщается о текущем состоянии календаря.

aws ssm get-calendar-state \
    --calendar-names "MyCalendar"

Вывод:

{
    "State": "OPEN",
    "AtTime": "2020-02-19T22:28:51Z",
    "NextTransitionTime": "2020-02-24T21:15:19Z"
}

Пример 2: Получение состояния календаря изменений в указанное время

Этот get-calendar-state пример возвращает состояние календаря в указанное время.

aws ssm get-calendar-state \
    --calendar-names "MyCalendar" \
    --at-time "2020-07-19T21:15:19Z"

Вывод:

{
    "State": "CLOSED",
    "AtTime": "2020-07-19T21:15:19Z"
}

Дополнительную информацию см. в разделе «Получение состояния календаря изменений» в руководстве пользователя AWS Systems Manager.

Вывод

Состояние -> (строка)

Состояние календаря. Календарь OPEN указывает, что действия разрешены, а календарь CLOSED указывает, что действия не разрешены.

AtTime -> (строка)

Время, указанное в вашем запросе в формате ISO 8601. Если вы не укажете время, GetCalendarState использует текущее время.

NextTransitionTime -> (строка)

Время, в формате ISO 8601, когда состояние календаря изменится. Если текущее состояние календаря — OPEN, NextTransitionTime указывает момент изменения состояния календаря на CLOSED, и наоборот.

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

Spec-Zone.ru

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