count-closed-workflow-executions

Описание

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

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

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

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

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

Синопсис

  count-closed-workflow-executions
--domain <value>
[--start-time-filter <value>]
[--close-time-filter <value>]
[--execution-filter <value>]
[--type-filter <value>]
[--tag-filter <value>]
[--close-status-filter <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 (строка)

--start-time-filter (структура)

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

oldestDate=timestamp,latestDate=timestamp

Синтаксис JSON:

{
  "oldestDate": timestamp,
  "latestDate": timestamp
}

--close-time-filter (структура)

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

oldestDate=timestamp,latestDate=timestamp

Синтаксис JSON:

{
  "oldestDate": timestamp,
  "latestDate": timestamp
}

--execution-filter (структура)

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

workflowId=string

Синтаксис JSON:

{
  "workflowId": "string"
}

--type-filter (структура)

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

name=string,version=string

Синтаксис JSON:

{
  "name": "string",
  "version": "string"
}

--tag-filter (структура)

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

tag=string

Синтаксис JSON:

{
  "tag": "string"
}

--close-status-filter (структура)

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

status=string

Синтаксис JSON:

{
  "status": "COMPLETED"|"FAILED"|"CANCELED"|"TERMINATED"|"CONTINUED_AS_NEW"|"TIMED_OUT"
}

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

Примеры

Подсчёт закрытых исполнений рабочих потоков

Вы можете использовать swf count-closed-workflow-executions для получения количества закрытых исполнений рабочих потоков для заданного домена. Вы можете указать фильтры для подсчёта определённых классов исполнений.

Необходимы аргументы --domain и либо --close-time-filter, либо --start-time-filter. Все остальные аргументы являются необязательными.

aws swf count-closed-workflow-executions \
    --domain DataFrobtzz \
    --close-time-filter "{ \"latestDate\" : 1377129600, \"oldestDate\" : 1370044800 }"

Вывод:

{
    "count": 2,
    "truncated": false
}

Если «truncated» равно true, то «count» представляет собой максимальное количество, которое может вернуть Amazon SWF. Любые дальнейшие результаты усекаются.

Для уменьшения количества возвращаемых результатов вы можете:

• изменить значения --close-time-filter или --start-time-filter, чтобы сузить диапазон времени поиска. Каждый

  из этих аргументов является взаимоисключающим: в запросе можно указать только один из них.

• использовать аргументы --close-status-filter, --execution-filter, --tag-filter или --type-filter для дальнейшей

  фильтрации результатов. Однако эти аргументы также взаимоисключают друг друга.

Вывод

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

truncated -> (булево значение)