Spec-Zone.ru › AWS CLI v2

[ aws . redshift-serverless ]

get-scheduled-action

Описание

Возвращает информацию о запланированном действии.

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

Синтаксис

  get-scheduled-action
--scheduled-action-name <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]

Параметры

--scheduled-action-name (строка)

Название запланированного действия.

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

Регион для использования. Переопределяет настройки конфигурации/среды.

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

Вывод

scheduledAction -> (структура)

Возвращаемый объект запланированного действия.

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

Конечное время

namespaceName -> (строка)

Конечное время в UTC, когда расписание больше не активно. После этого времени запланированное действие не срабатывает.

nextInvocations -> (список)

Массив временных меток, когда произойдут следующие запланированные действия.

(временная метка)

roleArn -> (строка)

ARN роли IAM для принятия роли для выполнения запланированного действия. Эта роль IAM должна иметь разрешения на выполнение операции Amazon Redshift Serverless API в запланированном действии. Эта роль IAM должна разрешить планировщику Amazon Redshift планировать создание снимков. (Принципиальный планировщик.redshift.amazonaws.com) для принятия полномочий от вашего имени. Для получения дополнительной информации о роли IAM, которую следует использовать с планировщиком Amazon Redshift, см. Использование политик на основе идентификации для Amazon Redshift в руководстве по управлению Amazon Redshift

schedule -> (структура помеченного объединения)

Расписание для одноразового (в формате временной метки) или повторяющегося (в формате cron) запланированного действия. Вызовы расписания должны быть разделены не менее чем на один час. Время в формате UTC.

  • Формат временной метки at — yyyy-mm-ddThh:mm:ss . Например, 2016-03-04T17:27:00 .
  • Формат выражения cron — (Minutes Hours Day-of-month Month Day-of-week Year) . Например, "(0 10 ? * MON *)" . Для получения дополнительной информации см. Выражения cron в Руководстве пользователя Amazon CloudWatch Events .

Примечание

Это структура помеченного объединения. Только один из следующих ключей верхнего уровня может быть задан: at, cron.

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

Временная метка, когда Amazon Redshift Serverless должен выполнить запланированное действие. Временная метка в формате UTC. Формат выражения at — yyyy-mm-ddThh:mm:ss . Например, 2016-03-04T17:27:00 .

cron -> (строка)

Выражение cron для планирования повторяющегося запланированного действия. Вызовы расписания должны быть разделены не менее чем на один час. Время в формате UTC.

Формат выражений cron — (Minutes Hours Day-of-month Month Day-of-week Year) . Например, "(0 10 ? * MON *)" . Для получения дополнительной информации см. Выражения cron в Руководстве пользователя Amazon CloudWatch Events .

scheduledActionDescription -> (строка)

Описание запланированного действия.

scheduledActionName -> (строка)

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

scheduledActionUuid -> (строка)

uuid запланированного действия.

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

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

state -> (строка)

Состояние запланированного действия.

targetAction -> (структура помеченного объединения)

Строка в формате JSON операции Amazon Redshift Serverless API с параметрами ввода. Вот пример целевого действия.

"{"CreateSnapshot": {"NamespaceName": "sampleNamespace","SnapshotName": "sampleSnapshot", "retentionPeriod": "1"}}"

Примечание

Это структура помеченного объединения. Только один из следующих ключей верхнего уровня может быть задан: createSnapshot.

createSnapshot -> (структура)

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

namespaceName -> (строка)

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

retentionPeriod -> (целое число)

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

snapshotNamePrefix -> (строка)

Префикс строки, добавляемый к имени снимка, создаваемого запланированным действием. Окончательное имя снимка — это префикс строки, добавленный с датой и временем создания снимка.

tags -> (список)

Массив объектов тегов для ассоциации со снимком.

(структура)

Карта пар ключ-значение.

key -> (строка)

Ключ, используемый в теге.

value -> (строка)

Значение тега.

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

Spec-Zone.ru

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