list-workflow-types

Описание

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

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

• Используйте элемент Resource с именем домена, чтобы ограничить действие только указанными доменам.
• Используйте элемент Action, чтобы разрешить или запретить разрешение на вызов этого действия.
• Вы не можете использовать политику IAM для ограничения параметров этого действия.

Если у вызывающего пользователя недостаточно разрешений для вызова действия или значения параметров выходят за пределы заданных ограничений, действие завершается ошибкой. Соответствующий атрибут события устанавливает параметр cause в значение OPERATION_NOT_PERMITTED. Подробнее о политиках IAM и примеры см. в руководстве разработчика Amazon SWF (Using IAM to Manage Access to Amazon SWF Workflows).

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

list-workflow-types — это постраничная операция. Для получения всего набора результатов могут потребоваться несколько вызовов API. Вы можете отключить постраничный вывод, задав аргумент --no-paginate. При использовании --output text и аргумента --query в ответе постраничного вывода, аргумент --query должен извлекать данные из результатов следующих выражений запросов: typeInfos

Синтаксис

  list-workflow-types
--domain <value>
[--name <value>]
--registration-status <value>
[--reverse-order | --no-reverse-order]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--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 (строка)

--registration-status (строка)

--reverse-order | --no-reverse-order (логическое значение)

--cli-input-json | --cli-input-yaml (строка) Читает аргументы из предоставленной строки JSON. Строка JSON соответствует формату, предоставленному в --generate-cli-skeleton. Если другие аргументы заданы в командной строке, эти значения перепишут значения из JSON. Невозможно передать произвольные двоичные значения с помощью значения JSON, так как строка будет взята буквально. Это не может быть задано вместе с --cli-input-yaml.

--starting-token (строка)

--page-size (целое число)

--max-items (целое число)

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

Примеры

Перечисление типов рабочих процессов

Чтобы получить список типов рабочих процессов для домена, используйте swf list-workflow-types. Аргументы --domain и --registration-status обязательны. Вот простой пример.

aws swf list-workflow-types \
    --domain DataFrobtzz \
    --registration-status REGISTERED

Вывод:

{
    "typeInfos": [
        {
            "status": "REGISTERED",
            "creationDate": 1371454149.598,
            "description": "DataFrobtzz subscribe workflow",
            "workflowType": {
                "version": "v3",
                "name": "subscribe"
            }
        }
    ]
}

Как и в list-activity-types, вы можете использовать аргумент --name, чтобы выбрать только типы рабочих процессов с определённым именем, и использовать аргумент --maximum-page-size в сочетании с --next-page-token для постраничного вывода результатов. Чтобы изменить порядок возврата результатов, используйте --reverse-order.

Вывод

typeInfos -> (список)

nextPageToken -> (строка)