Spec-Zone.ru › AWS CLI v2

[ aws . stepfunctions ]

обновить-машину-состояний

Описание

Обновляет существующую машину состояний, изменяя её definition , roleArn , loggingConfiguration или EncryptionConfiguration . Запущенные выполнения будут продолжать использовать предыдущие definition и roleArn . Вы должны указать хотя бы один из definition или roleArn, иначе получите ошибку MissingRequiredParameter.

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

Квалифицированный 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>

После обновления машины состояний вы можете установить параметр publish в значение true в том же действии, чтобы опубликовать новую версию. Таким образом, вы можете включить жёсткую версионирование вашей машины состояний.

Примечание

Сервис Step Functions присваивает монотонно возрастающие целые числа для версий машин состояний, начиная с номера версии 1.

Примечание

Все StartExecution вызовы в течение нескольких секунд используют обновлённые definition и roleArn . Выполнения, начатые сразу после вызова UpdateStateMachine, могут использовать предыдущую машину состояний definition и roleArn.

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

Синтаксис

  update-state-machine
--state-machine-arn <value>
[--definition <value>]
[--role-arn <value>]
[--logging-configuration <value>]
[--tracing-configuration <value>]
[--publish | --no-publish]
[--version-description <value>]
[--encryption-configuration <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) машины состояний.

--definition (строка)

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

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

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

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

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

level -> (строка)

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

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

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

destinations -> (список)

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

(структура)

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

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

logGroupArn -> (строка)

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

Синтаксис JSON:

{
  "level": "ALL"|"ERROR"|"FATAL"|"OFF",
  "includeExecutionData": true|false,
  "destinations": [
    {
      "cloudWatchLogsLogGroup": {
        "logGroupArn": "string"
      }
    }
    ...
  ]
}

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

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

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

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

Краткая форма:

enabled=boolean

Синтаксис JSON:

{
  "enabled": true|false
}

--publish | --no-publish (логическое значение)

Указывает, публиковать ли версию машины состояний. По умолчанию значение false . Чтобы опубликовать версию после обновления машины состояний, установите publish в значение true.

--version-description (строка)

Необязательное описание версии машины состояний для публикации.

Вы можете указать параметр versionDescription только если вы установили publish в значение true.

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

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

kmsKeyId -> (строка)

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

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

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

type -> (строка)

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

Краткая форма:

kmsKeyId=string,kmsDataKeyReusePeriodSeconds=integer,type=string

Синтаксис JSON:

{
  "kmsKeyId": "string",
  "kmsDataKeyReusePeriodSeconds": integer,
  "type": "AWS_OWNED_KEY"|"CUSTOMER_MANAGED_KMS_KEY"
}

--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
  • таблица
  • 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.

Вывод

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

Дата и время обновления машины состояний.

revisionId -> (строка)

Идентификатор ревизии обновлённой машины состояний.

stateMachineVersionArn -> (строка)

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

Если параметр publish не установлен в значение true, это поле возвращает null.

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

Spec-Zone.ru

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