Spec-Zone.ru › AWS CLI v2

[ aws . stepfunctions ]

describe-state-machine

Описание

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

Квалифицированный ARN машины состояний может ссылаться на состояние распределённой карты, определённое в машине состояний, ARN версии или ARN псевдонима.

Ниже приведены примеры квалифицированных и неквалифицированных ARN машин состояний:

  • Следующий квалифицированный ARN машины состояний ссылается на состояние распределённой карты с меткой mapStateLabel в машине состояний с именем myStateMachine . arn:partition:states:region:account-id:stateMachine:myStateMachine/mapStateLabel

Примечание

Если вы предоставите квалифицированный ARN машины состояний, который ссылается на состояние распределённой карты, запрос завершится ошибкой ValidationException .
  • Следующий квалифицированный ARN машины состояний ссылается на псевдоним с именем PROD . arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine:PROD>

Примечание

Если вы предоставите квалифицированный ARN машины состояний, который ссылается на ARN версии или ARN псевдонима, запрос начнёт выполнение для этой версии или псевдонима.
  • Следующий неквалифицированный ARN машины состояний ссылается на машину состояний с именем myStateMachine . arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine>

Этот API-действие возвращает детали для версии машины состояний, если stateMachineArn, который вы указали, является ARN версии машины состояний.

Примечание

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

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

Синопсис

  describe-state-machine
--state-machine-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]

Параметры

--state-machine-arn (строка)

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

Если вы укажете ARN версии машины состояний, этот API вернёт детали этой версии. ARN версии является комбинацией ARN машины состояний и номера версии, разделённых двоеточием (:). Например, stateMachineARN:1 .

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

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

Примечание

При вызове метки ARN для зашифрованной машины состояний параметр includedData = METADATA_ONLY не будет применяться, так как Step Functions необходимо расшифровать всё определение машины состояний, чтобы получить определение состояния Распределённой карты. В этом случае, вызывающая сторона API должна иметь право kms:Decrypt .

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

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

Переопределить 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.

Вывод

stateMachineArn -> (строка)

Идентификатор Amazon Resource Name (ARN) состояния машины.

Если в запросе был указан ARN версии состояния машины, API возвращает ARN версии. ARN версии представляет собой комбинацию ARN состояния машины и номера версии, разделенных двоеточием (:). Например, stateMachineARN:1 .

name -> (строка)

Имя состояния машины.

Имя не должно содержать:

  • пробелы
  • скобки < > { } [ ]
  • символы подстановки ? *
  • специальные символы " # % \ ^ | ~ ` $ & , ; : /
  • управляющие символы (U+0000-001F , U+007F-009F )

Для включения ведения журнала с помощью CloudWatch Logs имя должно содержать только символы 0-9, A-Z, a-z, - и _.

status -> (строка)

Текущий статус состояния машины.

definition -> (строка)

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

Если вызов выполнен с includedData = METADATA_ONLY , возвращаемое определение будет {} .

roleArn -> (строка)

Идентификатор Amazon Resource Name (ARN) роли IAM, используемой при создании этого состояния машины. (Роль IAM обеспечивает безопасность, предоставляя Step Functions доступ к ресурсам Amazon Web Services.)

type -> (строка)

Тип type состояния машины (STANDARD или EXPRESS ).

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

Дата создания состояния машины.

Для версии состояния машины creationDate — это дата создания версии.

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 включено.

label -> (строка)

Пользовательская или автоматически сгенерированная строка, идентифицирующая состояние Map. Этот параметр присутствует только если указанный в входных данных stateMachineArn является квалифицированным ARN состояния машины.

revisionId -> (строка)

Идентификатор пересмотра состояния машины.

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

description -> (строка)

Описание версии состояния машины.

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

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

kmsKeyId -> (строка)

Псевдоним, ARN псевдонима, ID ключа или 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