Spec-Zone.ru › AWS CLI v2

[ aws . swf ]

describe-activity-type

Описание

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

Управление доступом

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

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

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

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

Синтаксис

  describe-activity-type
--domain <value>
--activity-type <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 (строка)

Имя домена, в котором зарегистрирован тип активности.

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

Тип активности, о котором требуется получить информацию. Типы активности идентифицируются по name и version, которые были предоставлены при регистрации активности.

name -> (строка)

Имя этой активности.

Примечание

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

version -> (строка)

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

Примечание

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

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

name=string,version=string

Синтаксис JSON:

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

--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-auto-prompt (логическое значение)

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

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

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

Вывод

typeInfo -> (структура)

Общая информация о типе активности.

Статус типа активности (возвращаемый в структуре ActivityTypeInfo) может быть одним из следующих.

  • REGISTERED – Тип зарегистрирован и доступен. Рабочие процессы, поддерживающие этот тип, должны быть запущены.
  • DEPRECATED – Тип был устаревшим с помощью DeprecateActivityType, но по-прежнему используется. Вам следует поддерживать запуск рабочих процессов, поддерживающих этот тип. Вы не можете создавать новые задачи этого типа.

activityType -> (структура)

Структура типа ActivityType, представляющая тип активности.

name -> (строка)

Имя этой активности.

Примечание

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

version -> (строка)

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

Примечание

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

status -> (строка)

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

description -> (строка)

Описание типа активности, предоставленное в RegisterActivityType.

creationDate -> (метка времени)

Дата и время создания этого типа активности с помощью RegisterActivityType.

deprecationDate -> (метка времени)

Если УСТАРЕВШИЙ, дата и время вызова DeprecateActivityType.

configuration -> (структура)

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

defaultTaskStartToCloseTimeout -> (строка)

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

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

defaultTaskHeartbeatTimeout -> (строка)

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

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

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

defaultTaskList -> (структура)

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

name -> (строка)

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

defaultTaskPriority -> (строка)

Приоритет задачи по умолчанию для задач этого типа активности, указанный при регистрации. Если не задан, то 0 используется в качестве приоритета по умолчанию. Это значение по умолчанию можно переопределить при планировании задачи активности.

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

Дополнительные сведения об установке приоритета задачи см. в разделе Установка приоритета задачи в руководстве разработчика Amazon SWF.

defaultTaskScheduleToStartTimeout -> (строка)

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

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

defaultTaskScheduleToCloseTimeout -> (строка)

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

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

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

Spec-Zone.ru

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