Spec-Zone.ru › AWS CLI v2

[ aws . swf ]

register-activity-type

Описание

Регистрирует новый тип активности вместе с его параметрами конфигурации в указанном домене.

Предупреждение

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

Контроль доступа

Вы можете использовать политики IAM для управления доступом к этому действию к ресурсам Amazon SWF следующим образом:

  • Используйте элемент Resource с именем домена, чтобы ограничить действие только указанными доменам.
  • Используйте элемент Action для разрешения или запрета разрешения на вызов этого действия.
  • Ограничьте следующие параметры, используя элемент Condition с соответствующими ключами.
    • defaultTaskList.name : ограничение строки. Ключ — swf:defaultTaskList.name .
    • name : ограничение строки. Ключ — swf:name .
    • version : ограничение строки. Ключ — swf:version .

Если у вызывающего лица недостаточно разрешений для вызова действия или значения параметров выходят за пределы заданных ограничений, действие завершается с ошибкой. Соответствующий атрибут события параметр cause устанавливается в значение OPERATION_NOT_PERMITTED . Подробную информацию и примеры политик IAM см. в разделе «Использование IAM для управления доступом к рабочим процессам Amazon SWF» в руководстве разработчика Amazon SWF.

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

Синтаксис

  register-activity-type
--domain <value>
--name <value>
[--description <value>]
[--default-task-start-to-close-timeout <value>]
[--default-task-heartbeat-timeout <value>]
[--default-task-list <value>]
[--default-task-priority <value>]
[--default-task-schedule-to-start-timeout <value>]
[--default-task-schedule-to-close-timeout <value>]
--activity-version <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]

Параметры

--domain (строка)

Имя домена, в котором должна быть зарегистрирована эта активность.

--name (строка)

Имя типа активности в пределах домена.

Указанная строка не должна содержать : (двоеточие), / (слеш), | (вертикальная черта) или какие-либо управляющие символы (\u0000-\u001f | \u007f-\u009f ). Кроме того, она не должна быть строкой arn .

--description (строка)

Текстовое описание типа активности.

--default-task-start-to-close-timeout (строка)

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

Продолжительность задается в секундах, целое число, большее или равное 0 . Для указания неограниченной продолжительности можно использовать NONE .

--default-task-heartbeat-timeout (строка)

Если задано, указывает максимальное время, по истечении которого работник, обрабатывающий задачу данного типа, должен сообщить о ходе выполнения, вызвав RecordActivityTaskHeartbeat. Если таймаут истекает, задача активности автоматически завершается по таймауту. Это значение по умолчанию может быть переопределено при планировании задачи активности с помощью решения ScheduleActivityTask. Если работник активности впоследствии попытается записать heartbeat или вернуть результат, работник активности получит ошибку UnknownResource. В этом случае Amazon SWF больше не считает задачу активности действительной; работник активности должен очистить задачу активности.

Продолжительность задается в секундах, целое число, большее или равное 0 . Для указания неограниченной продолжительности можно использовать NONE .

--default-task-list (структура)

Если задано, указывает список задач по умолчанию для планирования задач данного типа активности. Этот список задач по умолчанию используется, если список задач не задан при планировании задачи с помощью решения ScheduleActivityTask .

name -> (строка)

Имя списка задач.

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

name=string

Синтаксис JSON:

{
  "name": "string"
}

--default-task-priority (строка)

Значение приоритета задачи по умолчанию для типа активности. Если не назначено, используется 0. Допустимые значения — целые числа, которые варьируются от Integer.MIN_VALUE (-2147483648) до Integer.MAX_VALUE (2147483647). Более высокие значения обозначают более высокий приоритет.

Дополнительную информацию о настройке приоритета задач см. в разделе «Настройка приоритета задач» в руководстве разработчика Amazon SWF.

--default-task-schedule-to-start-timeout (строка)

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

Продолжительность задается в секундах, целое число, большее или равное 0 . Для указания неограниченной продолжительности можно использовать NONE .

--default-task-schedule-to-close-timeout (строка)

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

Продолжительность задается в секундах, целое число, большее или равное 0 . Для указания неограниченной продолжительности можно использовать NONE .

--activity-version (строка)

Версия типа активности.

Примечание

Тип активности состоит из имени и версии, сочетание которых должно быть уникальным в рамках домена.

Указанная строка не должна содержать : (двоеточие), / (слеш), | (вертикальная черта) или какие-либо управляющие символы (\u0000-\u001f | \u007f-\u009f ). Кроме того, она не должна быть строкой arn .

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

Вывод

Нет

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

Spec-Zone.ru

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