Spec-Zone.ru › AWS CLI v2

[ aws . redshift-serverless ]

update-scheduled-action

Описание

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

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

Синтаксис

  update-scheduled-action
[--enabled | --no-enabled]
[--end-time <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)

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

--end-time (timestamp)

Конечное время (UTC) запланированного действия для обновления.

--role-arn (string)

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

--schedule (структура помеченных союзов)

Расписание для одноразового (в формате временной метки) или повторяющегося (в формате 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)

Временная метка, когда Amazon Redshift Serverless должен выполнить запланированное действие. Временная метка указана в UTC. Формат выражения at: 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 (строка)

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

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

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

--start-time (timestamp)

Начальное время (UTC) запланированного действия для обновления.

--target-action (структура помеченных союзов)

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

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

Примечание

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

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

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

namespaceName -> (строка)

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

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

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

snapshotNamePrefix -> (строка)

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

tags -> (список)

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

(структура)

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

key -> (строка)

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

value -> (строка)

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

Синтаксис JSON:

{
  "createSnapshot": {
    "namespaceName": "string",
    "retentionPeriod": integer,
    "snapshotNamePrefix": "string",
    "tags": [
      {
        "key": "string",
        "value": "string"
      }
      ...
    ]
  }
}

--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 (boolean)

Включить отладку.

--endpoint-url (строка)

Переопределить стандартный URL команды заданным URL.

--no-verify-ssl (boolean)

По умолчанию AWS CLI использует SSL при общении с AWS-сервисами. Для каждого SSL-соединения AWS CLI будет проверять сертификаты SSL. Этот параметр переопределяет стандартное поведение проверки сертификатов SSL.

--no-paginate (boolean)

Отключить автоматическую постраничную навигацию. Если автоматическая постраничная навигация отключена, AWS CLI выполнит только один вызов для первой страницы результатов.

--output (строка)

Стиль форматирования для вывода команд.

  • json
  • text
  • table
  • yaml
  • yaml-stream

--query (строка)

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

--profile (строка)

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

--region (строка)

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

--version (строка)

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

--color (строка)

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

  • on
  • off
  • auto

--no-sign-request (boolean)

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

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

Файл сертификата CA для проверки SSL-сертификатов. Переопределяет настройки конфигурации/среды.

--cli-read-timeout (int)

Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию — 60 секунд.

--cli-connect-timeout (int)

Максимальное время соединения сокета в секундах. Если значение установлено в 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 (boolean)

Отключить кли-пагинатор для вывода.

--cli-auto-prompt (boolean)

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

--no-cli-auto-prompt (boolean)

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

Вывод

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

Объект ScheduledAction, который был обновлён.

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

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

namespaceName -> (строка)

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

nextInvocations -> (список)

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

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

roleArn -> (строка)

ARN роли IAM для выполнения запланированного действия. Эта роль IAM должна иметь разрешение на выполнение операции Amazon Redshift Serverless API в запланированном действии. Эта роль IAM должна разрешать Amazon Redshift планировщику планировать создание моментальных снимков. (Принцип планировщика scheduler.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