[ aws . stepfunctions ]
list-state-machines
Описание
Выводит список существующих машин состояний.
Если возвращается nextToken, доступны дополнительные результаты. Значение nextToken — уникальный маркер постраничной навигации для каждой страницы. Повторите вызов, используя возвращённый маркер, чтобы получить следующую страницу. Остальные аргументы должны остаться неизменными. Каждый маркер постраничной навигации действует в течение 24 часов. Использование истекшего маркера приведёт к ошибке HTTP 400 InvalidToken.
Примечание
Данная операция является согласованной в конечном итоге. Результаты — попытка оптимизации и могут не отражать совсем свежие обновления и изменения.См. также: Документацию API AWS
list-state-machines — это постраничная операция. Для получения всех результатов могут потребоваться несколько API-вызовов. Вы можете отключить постраничную навигацию, указав аргумент --no-paginate. При использовании --output text и аргумента --query в ответе с постраничной навигацией, аргумент --query должен извлекать данные из результатов следующих выражений запросов: stateMachines
Синтаксис
list-state-machines
[--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]
Параметры
--cli-input-json | --cli-input-yaml (строка) Считывает аргументы из предоставленной JSON-строки. JSON-строка следует формату, предоставленному --generate-cli-skeleton. Если другие аргументы указаны в командной строке, эти значения переопределят значения, предоставленные в JSON. Передавать произвольные двоичные значения через JSON-строку невозможно, так как строка будет воспринята буквально. Этот параметр нельзя указывать вместе с --cli-input-yaml.
--starting-token (строка)
Маркер, указывающий, с какой точки начать постраничную навигацию. Это NextToken из ранее обрезанного ответа.
Примеры использования см. в разделе Постраничная навигация в Руководстве пользователя AWS Command Line Interface.
--page-size (целое число)
Размер каждой страницы для вызова AWS-сервиса. Это не влияет на количество элементов, возвращаемых в выводе команды. Установка меньшего размера страницы приводит к большему количеству вызовов AWS-сервиса, получая меньше элементов в каждом вызове. Это может помочь предотвратить истечение времени ожидания вызовов AWS-сервиса.
Примеры использования см. в разделе Постраничная навигация в Руководстве пользователя AWS Command Line Interface.
--max-items (целое число)
Общее количество элементов для возврата в выводе команды. Если общее количество доступных элементов превышает указанное значение, в выводе команды будет предоставлен NextToken. Для возобновления постраничной навигации укажите значение NextToken в аргументе starting-token последующей команды. Не используйте элемент ответа NextToken напрямую вне AWS CLI.
Примеры использования см. в разделе Постраничная навигация в Руководстве пользователя AWS Command Line Interface.
--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 версии 1, и двоичные значения должны передаваться буквально. При предоставлении содержимого файла, отображающего двоичные данные, 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.
Вывод
stateMachines -> (список)
(структура)
Содержит подробную информацию о машине состояний.
stateMachineArn -> (строка)
name -> (строка)
Имя машины состояний.
Имя не должно содержать:
- пробелы
- скобки
< > { } [ ] - символы подстановки
? * - специальные символы
" # % \ ^ | ~ ` $ & , ; : / - управляющие символы (
U+0000-001F,U+007F-009F)
Для включения логирования с CloudWatch Logs имя должно содержать только цифры 0-9, буквы A-Z, a-z, - и _.
type -> (строка)
creationDate -> (метка времени)
nextToken -> (строка)
nextToken, доступны дополнительные результаты. Значение nextToken — уникальный маркер постраничной навигации для каждой страницы. Повторите вызов, используя возвращённый маркер, чтобы получить следующую страницу. Остальные аргументы должны остаться неизменными. Каждый маркер постраничной навигации действует в течение 24 часов. Использование истекшего маркера приведёт к ошибке HTTP 400 InvalidToken.
© Copyright 2025, Amazon Web Services. Created using Sphinx.