Spec-Zone.ru › AWS CLI v2

[ aws . scheduler ]

create-schedule

Описание

Создаёт указанное расписание.

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

Синтаксис

  create-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, до которой расписание может вызвать свой целевой объект. В зависимости от выражения повторности расписания, вызовы могут прекратиться в или до указанной вами даты. 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 (строка)

Amazon Resource Name (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, после которой расписание может начать вызывать свой целевой объект. В зависимости от выражения повторности расписания, вызовы могут произойти в или после указанной вами даты. EventBridge Scheduler игнорирует StartDate для расписаний на один раз.

--state (строка)

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

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

  • ENABLED
  • DISABLED

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

Целевая точка расписания.

Arn -> (строка)

Идентификатор ресурса Amazon (ARN) целевой точки.

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

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

Arn -> (строка)

Идентификатор ресурса Amazon (ARN) очереди SQS, указанной в качестве назначения для очереди обработки ошибок.

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

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

CapacityProviderStrategy -> (список)

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

(структура)

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

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

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

capacityProvider -> (строка)

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

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

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

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. Для стратегии размещения random это поле не используется.

type -> (строка)

Тип стратегии размещения. Стратегия случайного размещения случайным образом размещает задачи на доступных кандидатах. Стратегия размещения spread равномерно распределяет размещение по доступным кандидатам на основе параметра поля. Стратегия 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 (ARN) определения задачи, используемого, если целевой объект события — задача Amazon ECS.

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

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

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

PartitionKey -> (строка)

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

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

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

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

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

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

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

RoleArn -> (строка)

Идентификатор ресурса Amazon (ARN) роли IAM, которую EventBridge Scheduler будет использовать для этой целевой точки при вызове расписания.

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

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

PipelineParameterList -> (список)

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

(структура)

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

Name -> (строка)

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

Value -> (строка)

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

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

Шаблон типа целевой точки для операции Amazon SQS ` SendMessage https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_SendMessage.html`__.

Идентификатор группы сообщений для использования, когда целевая точка — очередь 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