register-workflow-type

Описание

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

Срок хранения истории рабочего процесса задается действием RegisterDomain.

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

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

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

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

Синтаксис

  register-workflow-type
--domain <value>
--name <value>
[--description <value>]
[--default-task-start-to-close-timeout <value>]
[--default-execution-start-to-close-timeout <value>]
[--default-task-list <value>]
[--default-task-priority <value>]
[--default-child-policy <value>]
[--default-lambda-role <value>]
--workflow-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 (строка)

--description (строка)

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

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

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

Краткая запись:

name=string

Синтаксис JSON:

{
  "name": "string"
}

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

--default-child-policy (строка)

--default-lambda-role (строка)

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

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

Примеры

Регистрация типа рабочей последовательности

Чтобы зарегистрировать тип рабочей последовательности с помощью AWS CLI, используйте команду swf register-workflow-type.

aws swf register-workflow-type \
    --domain DataFrobtzz \
    --name "MySimpleWorkflow" \
    --workflow-version "v1"

При успешном выполнении команда не выводит никаких результатов.

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

{
    "message": "WorkflowType=[name=MySimpleWorkflow, version=v1]",
    "__type": "com.amazonaws.swf.base.model#TypeAlreadyExistsFault"
}

Поля --domain, --name и --workflow-version являются обязательными. Вы также можете установить описание рабочей последовательности, таймауты и политику для дочерней рабочей последовательности.

Дополнительную информацию см. в разделе RegisterWorkflowType в Справочнике по API Amazon Simple Workflow Service

Вывод

Нет