обновить-расписание
Описание
Обновляет указанное расписание. При вызове 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 применяет к расписанию после завершения вызова целевого объекта.
Возможные значения:
NONEDELETE
--client-token (строка)
--description (строка)
--end-date (временная метка)
EndDate. EventBridge Scheduler игнорирует EndDate для одноразовых расписаний.--flexible-time-window (структура)
Позволяет настроить временной интервал, в течение которого EventBridge Scheduler вызывает расписание.
MaximumWindowInMinutes -> (целое число)
Mode -> (строка)
Упрощенный синтаксис:
MaximumWindowInMinutes=integer,Mode=string
Синтаксис JSON:
{
"MaximumWindowInMinutes": integer,
"Mode": "OFF"|"FLEXIBLE"
}
--group-name (строка)
--kms-key-arn (строка)
--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 (временная метка)
StartDate. EventBridge Scheduler игнорирует StartDate для одноразовых расписаний.--state (строка)
Указывает, включено или выключено расписание.
Возможные значения:
ENABLEDDISABLED
--target (структура)
Целевая рассылка. Вы можете использовать эту операцию для изменения целевой рассылки, на которую ссылается ваш график.
Arn -> (строка)
DeadLetterConfig -> (структура)
Объект, содержащий информацию об очереди Amazon SQS, используемой EventBridge Scheduler в качестве очереди с сообщениями о неудачных попытках выполнения расписания. Если указано, EventBridge Scheduler отправляет неуспешные события, которые не были успешно доставлены в целевой объект, в очередь.
Arn -> (строка)
EcsParameters -> (структура)
Шаблонный тип целевого объекта для операции Amazon ECS ` RunTask https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_RunTask.html`__ API.
CapacityProviderStrategy -> (список)
Стратегия предоставления емкости для задачи.
(структура)
Подробности стратегии предоставления емкости.
base -> (целое число)
0.capacityProvider -> (строка)
weight -> (целое число)
EnableECSManagedTags -> (логическое значение)
EnableExecuteCommand -> (логическое значение)
Group -> (строка)
LaunchType -> (строка)
FARGATE поддерживается только в регионах, где поддерживается Fargate с Amazon ECS. Дополнительные сведения см. в разделе AWS Fargate на Amazon ECS в руководстве для разработчиков Amazon ECS .NetworkConfiguration -> (структура)
Эта структура определяет конфигурацию сети для задачи ECS.
awsvpcConfiguration -> (структура)
Указывает подсети Amazon VPC и группы безопасности для задачи, а также использовать или нет публичный IP-адрес. Эта структура актуальна только для задач ECS, которые используют режим сети awsvpc.
AssignPublicIp -> (строка)
ENABLED только тогда, когда LaunchType в EcsParameters установлено в FARGATE.SecurityGroups -> (список)
Указывает группы безопасности, связанные с задачей. Все эти группы безопасности должны находиться в одной VPC. Вы можете указать до пяти групп безопасности. Если вы не укажете группу безопасности, используется группа безопасности по умолчанию для VPC.
(строка)
Subnets -> (список)
Указывает подсети, связанные с задачей. Все эти подсети должны находиться в одной VPC. Вы можете указать до 16 подсетей.
(строка)
PlacementConstraints -> (список)
Массив объектов ограничений размещения для использования в задаче. Вы можете указать до 10 ограничений на задачу (включая ограничения в определении задачи и те, которые заданы во время выполнения).
(структура)
Объект, представляющий ограничение размещения задачи.
expression -> (строка)
distinctInstance. Дополнительные сведения см. в разделе Язык запросов кластера в руководстве для разработчиков Amazon ECS .type -> (строка)
distinctInstance, чтобы гарантировать, что каждая задача в конкретной группе выполняется на разных экземплярах контейнера. Используйте memberOf, чтобы ограничить выбор группой допустимых кандидатов.PlacementStrategy -> (список)
Стратегия размещения задач для задачи или сервиса.
(структура)
Стратегия размещения задач для задачи или сервиса.
field -> (строка)
instanceId (или instanceId, что имеет тот же эффект), или любой платформенный или пользовательский атрибут, который применяется к экземпляру контейнера, например, attribute:ecs.availability-zone. Для стратегии размещения binpack допустимые значения - cpu и memory. Для случайной стратегии размещения это поле не используется.type -> (строка)
PlatformVersion -> (строка)
1.1.0.PropagateTags -> (строка)
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 -> (строка)
EventBridgeParameters -> (структура)
Шаблонный тип целевого объекта для операции EventBridge ` PutEvents https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutEvents.html`__ API.
DetailType -> (строка)
Source -> (строка)
Input -> (строка)
KinesisParameters -> (структура)
Шаблонный тип целевого объекта для операции Amazon Kinesis ` PutRecord kinesis/latest/APIReference/API_PutRecord.html`__ API.
PartitionKey -> (строка)
RetryPolicy -> (структура)
Объект RetryPolicy, содержащий информацию о параметрах политики повторных попыток, включая максимальный возраст события и максимальное количество попыток доставки события EventBridge Scheduler в целевой объект.
MaximumEventAgeInSeconds -> (целое число)
MaximumRetryAttempts -> (целое число)
MaximumEventAgeInSeconds.RoleArn -> (строка)
SageMakerPipelineParameters -> (структура)
Шаблонный тип целевого объекта для операции Amazon SageMaker ` StartPipelineExecution https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_StartPipelineExecution.html`__ API.
PipelineParameterList -> (список)
Список имен параметров и значений для использования при выполнении пайплайна построения модели SageMaker.
(структура)
Пара имя-значение для использования при запуске пайплайна построения модели SageMaker.
Name -> (строка)
Value -> (строка)
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 -> (строка)
Синтаксис 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 -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.