record-activity-task-heartbeat

Описание

Используется рабочими процессами задач активности для сообщения службе о том, что ActivityTask, представленный указанным taskToken, всё ещё выполняется. Рабочий процесс может также указать детали выполнения, например, процент завершения, используя параметр details. Данное действие также может использоваться рабочим процессом для проверки запроса на отмену задачи активности. Если попытка отмены для указанной задачи предпринимается, то булевый флаг cancelRequested, возвращаемый службой, устанавливается в значение true.

Это действие сбрасывает таймер taskHeartbeatTimeout. Значение таймера taskHeartbeatTimeout указано в RegisterActivityType.

Это действие само по себе не создаёт события в истории выполнения потока работы. Однако, если задача истечёт по таймауту, история выполнения потока работы содержит событие ActivityTaskTimedOut, которое содержит информацию из последнего отчёта о работе, сгенерированного рабочим процессом задачи активности.

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

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

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

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

Синтаксис

  record-activity-task-heartbeat
--task-token <value>
[--details <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]

Параметры

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

--details (строка)

--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 для вывода.

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

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

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

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

Вывод

cancelRequested -> (логическое значение)