Spec-Zone.ru › AWS CLI v2

[ aws . stepfunctions ]

update-state-machine-alias

Описание

Обновляет конфигурацию существующего алиаса машины состояний, изменяя его description или routingConfiguration.

Вы должны указать хотя бы один из параметров description или routingConfiguration для обновления алиаса машины состояний.

Примечание

UpdateStateMachineAlias — это идемпотентный API. Step Functions основывает проверку идемпотентности на параметрах stateMachineAliasArn, description и routingConfiguration. Запросы с одинаковыми параметрами возвращают идемпотентный ответ.

Примечание

Данная операция является эвентуально согласованной. Все запросы StartExecution, выполненные в течение нескольких секунд, используют последнюю конфигурацию алиаса. Исполнения, начатые сразу после вызова UpdateStateMachineAlias, могут использовать предыдущую конфигурацию маршрутизации.

Связанные операции:

  • CreateStateMachineAlias
  • DescribeStateMachineAlias
  • ListStateMachineAliases
  • DeleteStateMachineAlias

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

Синтаксис

  update-state-machine-alias
--state-machine-alias-arn <value>
[--description <value>]
[--routing-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-alias-arn (строка)

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

--description (строка)

Описание алиаса машины состояний.

--routing-configuration (список)

Конфигурация маршрутизации алиаса машины состояний.

Массив объектов RoutingConfig, указывающих до двух версий машины состояний, для которых алиас запускает исполнения.

(структура)

Содержит подробности о конфигурации маршрутизации алиаса машины состояний. В конфигурации маршрутизации вы определяете массив объектов, которые указывают до двух версий машины состояний. Вы также указываете процент трафика, направляемого на каждую версию.

stateMachineVersionArn -> (строка)

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

Если вы указываете ARN второй версии, она должна принадлежать той же машине состояний, что и первая версия.

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

Процент трафика, который вы хотите направить на версию машины состояний. Сумма весов в конфигурации маршрутизации должна быть равна 100.

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

stateMachineVersionArn=string,weight=integer ...

Синтаксис JSON:

[
  {
    "stateMachineVersionArn": "string",
    "weight": integer
  }
  ...
]

--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
  • table
  • yaml
  • yaml-stream

--query (строка)

Запрос JMESPath для фильтрации данных ответа.

--profile (строка)

Использовать определенный профиль из файла учетных данных.

--region (строка)

Регион для использования. Переопределяет параметры конфигурации/среды.

--version (строка)

Отобразить версию этого инструмента.

--color (строка)

Включить/отключить вывод цвета.

  • on
  • off
  • auto

--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 -> (метка времени)

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

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

Spec-Zone.ru

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