Spec-Zone.ru › AWS CLI v2

[ aws . scheduler ]

get-schedule

Описание

Извлекает указанное расписание.

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

Синтаксис

  get-schedule
[--group-name <value>]
--name <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]

Параметры

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

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

--name (строка)

Имя расписания для извлечения.

--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
  • text
  • table
  • yaml
  • yaml-stream

--query (строка)

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

--profile (строка)

Использование определенного профиля из вашего файла аутентификации.

--region (строка)

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

--version (строка)

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

--color (строка)

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

  • on
  • off
  • auto

--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-auto-prompt (логическое значение)

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

--no-cli-auto-prompt (логическое значение)

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

Вывод

ActionAfterCompletion -> (строка)

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

Arn -> (строка)

Amazon Resource Name (ARN) расписания.

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

Время создания расписания.

Description -> (строка)

Описание расписания.

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

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

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

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

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

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

Mode -> (строка)

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

GroupName -> (строка)

Имя группы расписания, связанной с этим расписанием.

KmsKeyArn -> (строка)

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

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

Время последнего изменения расписания.

Name -> (строка)

Имя расписания.

ScheduleExpression -> (строка)

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

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

ScheduleExpressionTimezone -> (строка)

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

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

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

State -> (строка)

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

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

Целевая дата расписания.

Arn -> (строка)

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

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

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

Arn -> (строка)

Идентификатор ресурса Amazon (ARN) очереди SQS, указанной в качестве пункта назначения для очереди «письма-возврата».

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

Шаблонный тип целевого объекта для операции API 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 -> (строка)

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

Шаблонный тип целевого объекта для операции API 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 -> (структура)

Шаблонный тип целевого объекта для операции API 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 -> (структура)

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

PipelineParameterList -> (список)

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

(структура)

Пара имя-значение для запуска выполнения SageMaker Model Building Pipeline.

Name -> (строка)

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

Value -> (строка)

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

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

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

MessageGroupId -> (строка)

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

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

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

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