Spec-Zone.ru › AWS CLI v2

[ aws . scheduler ]

обновить-расписание

Описание

Обновляет указанное расписание. При вызове UpdateSchedule, EventBridge Scheduler использует все значения, включая пустые, указанные в запросе, и перезаписывает существующее расписание. Это сделано по умолчанию. Это означает, что если вы не зададите необязательное поле в вашем запросе, это поле будет установлено в его системное значение по умолчанию после обновления.

Перед вызовом этой операции рекомендуется вызвать операцию API GetSchedule и записать все необязательные параметры для вашего вызова UpdateSchedule.

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

Синтаксис

  update-schedule
[--action-after-completion <value>]
[--client-token <value>]
[--description <value>]
[--end-date <value>]
--flexible-time-window <value>
[--group-name <value>]
[--kms-key-arn <value>]
--name <value>
--schedule-expression <value>
[--schedule-expression-timezone <value>]
[--start-date <value>]
[--state <value>]
--target <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]

Параметры

--action-after-completion (строка)

Указывает действие, которое EventBridge Scheduler применяет к расписанию после завершения вызова целевого объекта.

Возможные значения:

  • NONE
  • DELETE

--client-token (строка)

Уникальный, чувствительный к регистру идентификатор, который вы предоставляете, чтобы обеспечить идемпотентность запроса. Если вы не укажете маркер клиента, EventBridge Scheduler использует случайный маркер для запроса, чтобы обеспечить идемпотентность.

--description (строка)

Описание, которое вы указываете для расписания.

--end-date (временная метка)

Дата в формате UTC, до которой расписание может вызвать свой целевой объект. В зависимости от выражения повторения расписания, вызовы могут завершиться в или до указанной вами EndDate. EventBridge Scheduler игнорирует EndDate для одноразовых расписаний.

--flexible-time-window (структура)

Позволяет настроить временной интервал, в течение которого EventBridge Scheduler вызывает расписание.

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

Максимальный временной интервал, в течение которого расписание может быть вызвано.

Mode -> (строка)

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

Упрощенный синтаксис:

MaximumWindowInMinutes=integer,Mode=string

Синтаксис JSON:

{
  "MaximumWindowInMinutes": integer,
  "Mode": "OFF"|"FLEXIBLE"
}

--group-name (строка)

Имя группы расписания, с которой связано расписание. Вам необходимо предоставить это значение, чтобы EventBridge Scheduler смог найти расписание, которое вы хотите обновить. Если вы опустите это значение, EventBridge Scheduler предположит, что группа связана с группой по умолчанию.

--kms-key-arn (строка)

ARN для управляемого клиентом KMS-ключа, который вы хотите использовать EventBridge Scheduler для шифрования и дешифрования ваших данных.

--name (строка)

Имя расписания, которое вы обновляете.

--schedule-expression (строка)

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

  • at выражение - at(yyyy-mm-ddThh:mm:ss)
  • rate выражение - rate(value unit)
  • cron выражение - cron(fields)

Вы можете использовать at выражения для создания одноразовых расписаний, которые вызовут целевой объект один раз, в указанное время и часовом поясе. Вы можете использовать rate и cron выражения для создания повторяющихся расписаний. Расписания на основе скорости полезны, когда вы хотите вызывать целевой объект через регулярные интервалы, например, каждые 15 минут или каждые пять дней. Расписания на основе cron полезны, когда вы хотите вызывать целевой объект периодически в определенное время, например, в 8:00 утра (UTC+0) каждого 1-го числа месяца.

cron выражение состоит из шести полей, разделенных пробелами: (minutes hours day_of_month month day_of_week year) .

rate выражение состоит из значения как положительного целого числа и единицы со следующими вариантами: minute | minutes | hour | hours | day | days

Для получения дополнительной информации и примеров см. Типы расписаний в EventBridge Scheduler в Руководстве пользователя EventBridge Scheduler.

--schedule-expression-timezone (строка)

Часовой пояс, в котором оценивается выражение расписания.

--start-date (временная метка)

Дата в формате UTC, после которой расписание может начать вызывать свой целевой объект. В зависимости от выражения повторения расписания, вызовы могут происходить в или после указанной вами StartDate. EventBridge Scheduler игнорирует StartDate для одноразовых расписаний.

--state (строка)

Указывает, включено или выключено расписание.

Возможные значения:

  • ENABLED
  • DISABLED

--target (структура)

Целевая рассылка. Вы можете использовать эту операцию для изменения целевой рассылки, на которую ссылается ваш график.

Arn -> (строка)

Amazon Resource Name (ARN) целевой рассылки.

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

Объект, содержащий информацию об очереди Amazon SQS, используемой EventBridge Scheduler в качестве очереди с сообщениями о неудачных попытках выполнения расписания. Если указано, EventBridge Scheduler отправляет неуспешные события, которые не были успешно доставлены в целевой объект, в очередь.

Arn -> (строка)

Amazon Resource Name (ARN) очереди SQS, указанной в качестве пункта назначения для очереди с сообщениями о неудачных попытках.

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

Шаблонный тип целевого объекта для операции Amazon ECS ` RunTask https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_RunTask.html`__ API.

CapacityProviderStrategy -> (список)

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

(структура)

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

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

Значение base указывает минимальное количество задач, которые необходимо запустить на указанном поставщике емкости. Только один поставщик емкости в стратегии предоставления емкости может иметь определенное значение base. Если значение не указано, используется значение по умолчанию 0.

capacityProvider -> (строка)

Короткое имя поставщика емкости.

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

Значение weight указывает относительный процент от общего количества запушенных задач, которые должны использовать указанного поставщика емкости. Значение weight учитывается после удовлетворения значения base, если оно определено.

EnableECSManagedTags -> (логическое значение)

Указывает, нужно ли включить управляемые Amazon ECS теги для задачи. Дополнительные сведения см. в разделе Маркирование ваших ресурсов Amazon ECS в руководстве для разработчиков Amazon ECS .

EnableExecuteCommand -> (логическое значение)

Включает или отключает функциональность выполнения команд для контейнеров в этой задаче. Если значение равно true, это включает функциональность выполнения команд для всех контейнеров в задаче.

Group -> (строка)

Указывает группу задач ECS для задачи. Максимальная длина составляет 255 символов.

LaunchType -> (строка)

Указывает тип запуска, на котором выполняется ваша задача. Тип запуска, который вы указываете здесь, должен соответствовать одному из типов запуска (совместимости) целевой задачи. Значение FARGATE поддерживается только в регионах, где поддерживается Fargate с Amazon ECS. Дополнительные сведения см. в разделе AWS Fargate на Amazon ECS в руководстве для разработчиков Amazon ECS .

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

Эта структура определяет конфигурацию сети для задачи ECS.

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

Указывает подсети Amazon VPC и группы безопасности для задачи, а также использовать или нет публичный IP-адрес. Эта структура актуальна только для задач ECS, которые используют режим сети awsvpc.

AssignPublicIp -> (строка)

Указывает, получает ли интерфейс эластичной сети задачи публичный IP-адрес. Вы можете указать ENABLED только тогда, когда LaunchType в EcsParameters установлено в FARGATE.

SecurityGroups -> (список)

Указывает группы безопасности, связанные с задачей. Все эти группы безопасности должны находиться в одной VPC. Вы можете указать до пяти групп безопасности. Если вы не укажете группу безопасности, используется группа безопасности по умолчанию для VPC.

(строка)

Subnets -> (список)

Указывает подсети, связанные с задачей. Все эти подсети должны находиться в одной VPC. Вы можете указать до 16 подсетей.

(строка)

PlacementConstraints -> (список)

Массив объектов ограничений размещения для использования в задаче. Вы можете указать до 10 ограничений на задачу (включая ограничения в определении задачи и те, которые заданы во время выполнения).

(структура)

Объект, представляющий ограничение размещения задачи.

expression -> (строка)

Выражение языка запросов кластера для применения к ограничению. Вы не можете указать выражение, если тип ограничения - distinctInstance. Дополнительные сведения см. в разделе Язык запросов кластера в руководстве для разработчиков Amazon ECS .

type -> (строка)

Тип ограничения. Используйте distinctInstance, чтобы гарантировать, что каждая задача в конкретной группе выполняется на разных экземплярах контейнера. Используйте memberOf, чтобы ограничить выбор группой допустимых кандидатов.

PlacementStrategy -> (список)

Стратегия размещения задач для задачи или сервиса.

(структура)

Стратегия размещения задач для задачи или сервиса.

field -> (строка)

Поле для применения стратегии размещения. Для стратегии размещения spread допустимые значения - instanceId (или instanceId, что имеет тот же эффект), или любой платформенный или пользовательский атрибут, который применяется к экземпляру контейнера, например, attribute:ecs.availability-zone. Для стратегии размещения binpack допустимые значения - cpu и memory. Для случайной стратегии размещения это поле не используется.

type -> (строка)

Тип стратегии размещения. Случайная стратегия размещения случайным образом размещает задачи на доступных кандидатах. Стратегия размещения spread равномерно распределяет размещение по доступным кандидатам на основе параметра field. Стратегия binpack размещает задачи на доступных кандидатах с наименьшим доступным количеством ресурса, указанного с параметром field. Например, если вы применяете binpack к памяти, задача размещается на экземпляре с наименьшим количеством доступной памяти (но все равно достаточно для запуска задачи).

PlatformVersion -> (строка)

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

PropagateTags -> (строка)

Указывает, нужно ли распространять теги из определения задачи на задачу. Если значение не указано, теги не распространяются. Теги могут быть распространены только на задачу во время создания задачи. Чтобы добавить теги к задаче после создания задачи, используйте действие API Amazon ECS ` TagResource https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_TagResource.html`__.

ReferenceId -> (строка)

Идентификатор ссылки для задачи.

Tags -> (список)

Метаданные, которые вы применяете к задаче для помощи в ее классификации и организации. Каждый тег состоит из ключа и необязательного значения, которые вы определяете. Дополнительные сведения см. в разделе ` RunTask https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_RunTask.html`__ в Справочном руководстве по API Amazon ECS.

(словарь)

key -> (строка)

value -> (строка)

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

Количество задач, которые необходимо создать на основе TaskDefinition. Значение по умолчанию - 1.

TaskDefinitionArn -> (строка)

Amazon Resource Name (ARN) определения задачи для использования, если целевой объект события — задача Amazon ECS.

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

Шаблонный тип целевого объекта для операции EventBridge ` PutEvents https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutEvents.html`__ API.

DetailType -> (строка)

Свободноформатная строка максимальной длиной 128 символов, используемая для определения ожидаемых полей в деталях события.

Source -> (строка)

Источник события.

Input -> (строка)

Текст или хорошо сформированный JSON, передаваемый целевому объекту. Если вы настраиваете шаблонную Lambda, AWS Step Functions или целевой объект Amazon EventBridge, ввод должен быть хорошо сформированным JSON. Для всех других типов целевых объектов JSON не требуется. Если вы ничего не укажете для этого поля, EventBridge Scheduler отправит целевому объекту стандартное уведомление.

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

Шаблонный тип целевого объекта для операции Amazon Kinesis ` PutRecord kinesis/latest/APIReference/API_PutRecord.html`__ API.

PartitionKey -> (строка)

Указывает сегмент, в который EventBridge Scheduler отправляет событие. Дополнительные сведения см. в разделе Терминология и концепции Amazon Kinesis Data Streams в руководстве для разработчиков Amazon Kinesis Streams.

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

Объект RetryPolicy, содержащий информацию о параметрах политики повторных попыток, включая максимальный возраст события и максимальное количество попыток доставки события EventBridge Scheduler в целевой объект.

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

Максимальное время в секундах для продолжения попыток повторной отправки.

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

Максимальное количество попыток повторной отправки перед неудачей запроса. Повторные попытки с экспоненциальной задержкой продолжаются до тех пор, пока не будет сделано максимальное количество попыток или не будет достигнут срок действия MaximumEventAgeInSeconds.

RoleArn -> (строка)

Amazon Resource Name (ARN) роли IAM, которую EventBridge Scheduler будет использовать для этого целевого объекта при вызове расписания.

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

Шаблонный тип целевого объекта для операции Amazon SageMaker ` StartPipelineExecution https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_StartPipelineExecution.html`__ API.

PipelineParameterList -> (список)

Список имен параметров и значений для использования при выполнении пайплайна построения модели SageMaker.

(структура)

Пара имя-значение для использования при запуске пайплайна построения модели SageMaker.

Name -> (строка)

Имя параметра для запуска выполнения пайплайна построения модели SageMaker.

Value -> (строка)

Значение параметра для запуска выполнения пайплайна построения модели SageMaker.

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

Шаблонный тип целевого объекта для операции Amazon SQS ` SendMessage https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_SendMessage.html`__ API. Содержит идентификатор группы сообщений, используемый, когда целевой объект — очередь FIFO. Если вы указываете очередь Amazon SQS FIFO в качестве целевого объекта, в очереди должна быть включена проверка дублирования на основе содержимого. Дополнительные сведения см. в разделе Использование идентификатора дублирования сообщений Amazon SQS в руководстве для разработчиков Amazon SQS .

MessageGroupId -> (строка)

Идентификатор группы сообщений FIFO для использования в качестве целевого объекта.

Синтаксис JSON:

{
  "Arn": "string",
  "DeadLetterConfig": {
    "Arn": "string"
  },
  "EcsParameters": {
    "CapacityProviderStrategy": [
      {
        "base": integer,
        "capacityProvider": "string",
        "weight": integer
      }
      ...
    ],
    "EnableECSManagedTags": true|false,
    "EnableExecuteCommand": true|false,
    "Group": "string",
    "LaunchType": "EC2"|"FARGATE"|"EXTERNAL",
    "NetworkConfiguration": {
      "awsvpcConfiguration": {
        "AssignPublicIp": "ENABLED"|"DISABLED",
        "SecurityGroups": ["string", ...],
        "Subnets": ["string", ...]
      }
    },
    "PlacementConstraints": [
      {
        "expression": "string",
        "type": "distinctInstance"|"memberOf"
      }
      ...
    ],
    "PlacementStrategy": [
      {
        "field": "string",
        "type": "random"|"spread"|"binpack"
      }
      ...
    ],
    "PlatformVersion": "string",
    "PropagateTags": "TASK_DEFINITION",
    "ReferenceId": "string",
    "Tags": [
      {"string": "string"
        ...}
      ...
    ],
    "TaskCount": integer,
    "TaskDefinitionArn": "string"
  },
  "EventBridgeParameters": {
    "DetailType": "string",
    "Source": "string"
  },
  "Input": "string",
  "KinesisParameters": {
    "PartitionKey": "string"
  },
  "RetryPolicy": {
    "MaximumEventAgeInSeconds": integer,
    "MaximumRetryAttempts": integer
  },
  "RoleArn": "string",
  "SageMakerPipelineParameters": {
    "PipelineParameterList": [
      {
        "Name": "string",
        "Value": "string"
      }
      ...
    ]
  },
  "SqsParameters": {
    "MessageGroupId": "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 (логическое)

Включить отладочный вывод.

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

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

--no-verify-ssl (логическое)

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

--no-paginate (логическое)

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

--output (строка)

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

  • json
  • текст
  • таблица
  • yaml
  • yaml-поток

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

Вывод

ScheduleArn -> (строка)

Amazon Resource Name (ARN) запланированного обновления.

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

Spec-Zone.ru

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