Spec-Zone.ru › AWS CLI v2

[ aws . stepfunctions ]

describe-state-machine-for-execution

Описание

Предоставляет информацию об определении машины состояний, её ARN роли выполнения и конфигурации. Если выполнение было инициировано запуском Map, этот метод возвращает Amazon Resource Name (ARN) запуска Map в ответе. Возвращаемая машина состояний — это машина состояний, связанная с запуском Map.

Примечание

Этот операция имеет конечную согласованность. Результаты являются условными и могут не отражать самые последние обновления и изменения.

Этот API-метод не поддерживается для EXPRESS машин состояний.

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

Синтаксис

  describe-state-machine-for-execution
--execution-arn <value>
[--included-data <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]

Параметры

--execution-arn (строка)

Amazon Resource Name (ARN) выполнения, для которого требуется информация о машине состояний.

--included-data (строка)

Если определение вашей машины состояний зашифровано с помощью ключа KMS, вызывающие стороны должны иметь kms:Decrypt разрешение для расшифровки определения. В качестве альтернативы можно вызвать API с includedData = METADATA_ONLY, чтобы получить успешный ответ без зашифрованного определения.

Возможные значения:

  • ALL_DATA
  • METADATA_ONLY

--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 (строка)

Переопределить адрес по умолчанию для команды заданным адресом.

--no-verify-ssl (булево)

По умолчанию AWS CLI использует SSL при взаимодействии с AWS-сервисами. Для каждого подключения SSL AWS CLI проверит сертификаты SSL. Этот параметр переопределяет поведение проверки сертификатов SSL по умолчанию.

--no-paginate (булево)

Отключить автоматическую постраничную навигацию. Если автоматическая постраничная навигация отключена, AWS CLI выполнит только один вызов для первой страницы результатов.

--output (строка)

Стиль форматирования вывода команды.

  • json
  • text
  • таблица
  • 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 для вывода.

--cli-auto-prompt (булево)

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

--no-cli-auto-prompt (булево)

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

Вывод

stateMachineArn -> (строка)

Amazon Resource Name (ARN) машины состояний, связанной с выполнением.

name -> (строка)

Имя машины состояний, связанной с выполнением.

definition -> (строка)

Определение машины состояний на языке Amazon States. См. язык Amazon States.

roleArn -> (строка)

Amazon Resource Name (ARN) роли IAM машины состояний для выполнения.

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

Дата и время обновления машины состояний, связанной с выполнением. Для новой машины состояний это дата создания.

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

Тип данных LoggingConfiguration используется для настройки параметров CloudWatch Logs.

level -> (строка)

Определяет, какие категории событий истории выполнения регистрируются.

includeExecutionData -> (булево)

Определяет, включаются ли данные выполнения в журнал. При установке значения false данные исключаются.

destinations -> (список)

Массив объектов, описывающих место, где будут регистрироваться события истории выполнения. Ограничено размером 1. Требуется, если уровень журнала не установлен на OFF .

(структура)

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

Объект, описывающий группу логов CloudWatch. Дополнительную информацию см. в AWS::Logs::LogGroup в Руководстве пользователя CloudFormation.

logGroupArn -> (строка)

ARN группы логов CloudWatch, в которую должны передаваться журналы. ARN должен заканчиваться на :*

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

Выбирает, включена ли трассировка X-Ray.

enabled -> (булево)

При установке значения true трассировка X-Ray включена.

mapRunArn -> (строка)

Amazon Resource Name (ARN) запуска Map, который инициировал выполнение дочернего потока рабочего процесса. Это поле возвращается только тогда, когда executionArn является выполнением дочернего потока рабочего процесса, начатым состоянием Distributed Map.

label -> (строка)

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

revisionId -> (строка)

Идентификатор ревизии машины состояний. Первый идентификатор ревизии при создании машины состояний равен null.

Используйте параметр машины состояний revisionId для сравнения ревизии машины состояний с конфигурацией машины состояний, используемой для выполнений, без выполнения сравнения свойств, таких как definition и roleArn .

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

Настройки для настройки шифрования на сервере.

kmsKeyId -> (строка)

Псевдоним, ARN псевдонима, идентификатор ключа или ARN ключа симметричного ключа KMS для шифрования данных. Для указания ключа KMS в другом аккаунте Amazon Web Services необходимо использовать ARN ключа или ARN псевдонима.

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

Максимальная продолжительность, в течение которой Step Functions будет повторно использовать ключи данных. Когда срок действия истекает, Step Functions вызывает GenerateDataKey. Применяется только к управляемым пользователем ключам.

type -> (строка)

Тип шифрования

variableReferences -> (карта)

Карта имени состояния и списка переменных, на которые ссылается это состояние. Состояния, которые не используют ссылки на переменные, не будут отображаться в ответе.

key -> (строка)

value -> (список)

(строка)

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

Spec-Zone.ru

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