[ aws . redshift-serverless ]
create-scheduled-action
Описание
Создаёт запланированное действие. Запланированное действие содержит расписание и действие API Amazon Redshift. Например, вы можете задать расписание для выполнения операции API CreateSnapshot.
См. также: Документация AWS API
Синтаксис
create-scheduled-action
[--enabled | --no-enabled]
[--end-time <value>]
--namespace-name <value>
--role-arn <value>
--schedule <value>
[--scheduled-action-description <value>]
--scheduled-action-name <value>
[--start-time <value>]
--target-action <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]
Параметры
--enabled | --no-enabled (boolean)
state запланированного действия, см. ScheduledAction .--end-time (timestamp)
--namespace-name (string)
--role-arn (string)
--schedule (tagged union structure)
Расписание для одноразового (в формате метки времени) или повторяющегося (в формате cron) запланированного действия. Вызовы расписания должны быть разделены как минимум одним часом. Время указано в UTC.
- Формат метки времени:
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 -> (timestamp)
yyyy-mm-ddThh:mm:ss . Например, 2016-03-04T17:27:00 .cron -> (string)
Cron-выражение, используемое для планирования повторяющегося запланированного действия. Вызовы расписания должны быть разделены как минимум одним часом. Время указано в UTC.
Формат cron-выражений: (Minutes Hours Day-of-month Month Day-of-week Year) . Например, "(0 10 ? * MON *)" . Для получения дополнительной информации см. Cron-выражения в Руководстве пользователя Amazon CloudWatch Events .
Сокращённый синтаксис:
at=timestamp,cron=string
Синтаксис JSON:
{
"at": timestamp,
"cron": "string"
}
--scheduled-action-description (string)
--scheduled-action-name (string)
--start-time (timestamp)
--target-action (tagged union structure)
Строка в формате JSON операции API Amazon Redshift Serverless с входными параметрами. Ниже приведён пример целевого действия.
"{"CreateSnapshot": {"NamespaceName": "sampleNamespace","SnapshotName": "sampleSnapshot", "retentionPeriod": "1"}}"Примечание
Это структура помеченного объединения. Только один из следующих верхних ключей может быть задан:createSnapshot.createSnapshot -> (structure)
Параметры, которые можно использовать для настройки запланированного действия на создание снимка. Для получения дополнительной информации о создании запланированного действия см. CreateScheduledAction .
namespaceName -> (string)
retentionPeriod -> (integer)
snapshotNamePrefix -> (string)
tags -> (list)
Массив объектов тегов, которые необходимо добавить к снимку.
(structure)
Карта пар ключ-значение.
key -> (string)
value -> (string)
Синтаксис JSON:
{
"createSnapshot": {
"namespaceName": "string",
"retentionPeriod": integer,
"snapshotNamePrefix": "string",
"tags": [
{
"key": "string",
"value": "string"
}
...
]
}
}
--cli-input-json | --cli-input-yaml (string) Читает аргументы из предоставленной строки JSON. Строка JSON соответствует формату, предоставленному --generate-cli-skeleton. Если на командной строке указаны другие аргументы, эти значения переопределят значения, предоставленные в JSON. Невозможно передать произвольные двоичные значения с помощью значения, предоставленного в JSON, так как строка будет воспринята буквально. Это может не быть указано вместе с --cli-input-yaml.
--generate-cli-skeleton (string) Выводит каркас JSON в стандартный вывод без отправки запроса API. При отсутствии значения или значении input выводит пример входного JSON, который можно использовать в качестве аргумента для --cli-input-json. Аналогично, при указании значения yaml-input выведет пример входного YAML, который можно использовать с --cli-input-yaml. При указании значения output выполняет проверку входных данных команды и возвращает пример выходного JSON для этой команды. Сгенерированный каркас JSON нестабилен между версиями AWS CLI, и нет гарантий обратной совместимости в сгенерированном каркасе JSON.
Глобальные параметры
--debug (boolean)
Включить отладку.
--endpoint-url (string)
Переопределить URL по умолчанию команды указанным URL.
--no-verify-ssl (boolean)
По умолчанию AWS CLI использует SSL при общении с AWS-сервисами. Для каждого подключения SSL AWS CLI будет проверять сертификаты SSL. Этот параметр переопределяет поведение по умолчанию проверки SSL-сертификатов.
--no-paginate (boolean)
Отключить автоматическую постраничную навигацию. Если автоматическая постраничная навигация отключена, AWS CLI выполнит только один вызов для первой страницы результатов.
--output (string)
Стиль форматирования вывода команды.
- json
- text
- table
- yaml
- yaml-stream
--query (string)
JMESPath-запрос для фильтрации данных ответа.
--profile (string)
Использовать определённый профиль из файла ключей.
--region (string)
Регион для использования. Переопределяет настройки конфигурации/среды.
--version (string)
Отобразить версию этого инструмента.
--color (string)
Включить/выключить цветной вывод.
- on
- off
- auto
--no-sign-request (boolean)
Не подписывать запросы. Ключи не будут загружены, если этот аргумент указан.
--ca-bundle (string)
Файл сертификата CA для проверки SSL-сертификатов. Переопределяет настройки конфигурации/среды.
--cli-read-timeout (int)
Максимальное время чтения сокета в секундах. Если значение равно 0, чтение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию — 60 секунд.
--cli-connect-timeout (int)
Максимальное время подключения к сокету в секундах. Если значение равно 0, подключение к сокету будет блокирующим и не будет иметь таймаута. Значение по умолчанию — 60 секунд.
--cli-binary-format (string)
Стиль форматирования двоичных блоков. Формат по умолчанию — 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 (boolean)
Отключить пейджер CLI для вывода.
--cli-auto-prompt (boolean)
Автоматически запрашивать параметры входных данных CLI.
--no-cli-auto-prompt (boolean)
Отключить автоматическую запрос параметров входных данных CLI.
Вывод
scheduledAction -> (структура)
Возвращаемый ScheduledAction объект, описывающий свойства запланированного действия.
endTime -> (метка времени)
namespaceName -> (строка)
nextInvocations -> (список)
Массив меток времени, когда сработают следующие запланированные действия.
(метка времени)
roleArn -> (строка)
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 -> (метка времени)
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 -> (строка)
startTime -> (метка времени)
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.