Spec-Zone.ru › AWS CLI v2

[ aws . ssm ]

get-execution-preview

Описание

Инициализирует процесс получения существующей предварительной оценки, которая показывает влияние запуска указанного исполняемого скрипта Automation на целевые ресурсы.

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

Синтаксис

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

Идентификатор существующей предварительной оценки выполнения.

--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.

Вывод

ExecutionPreviewId -> (строка)

Сгенерированный идентификатор существующей предварительной оценки выполнения.

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

UTC-отметка времени, указывающая, когда завершилась операция предварительной оценки выполнения.

Status -> (строка)

Текущий статус операции предварительной оценки выполнения.

StatusMessage -> (строка)

Дополнительная информация о текущем статусе операции предварительной оценки выполнения.

ExecutionPreview -> (структура помеченных объединений)

Информация о изменениях, которые будут внесены при запуске выполнения.

Примечание

Это структура помеченных объединений. Только один из следующих верхнеуровневых ключей может быть установлен: Automation.

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

Информация о изменениях, которые будут внесены при запуске рабочей среды Automation.

StepPreviews -> (карта)

Информация о типе воздействия шага скрипта Automation на ресурс.

  • Mutating : Шаг скрипта Automation внесёт изменения в целевые ресурсы через действия создания, изменения или удаления ресурсов.
  • Non_Mutating : Шаг скрипта Automation получит данные о ресурсах, но не внесёт в них изменений. Эта категория, как правило, включает Describe* , List* , Get* и аналогичные действия API для чтения.
  • Undetermined : Неопределённый шаг вызывает выполнение, выполняемое другим сервисом оркестрации, таким как Lambda, Step Functions или Amazon Web Services Systems Manager Run Command. Неопределённый шаг может также вызывать сторонние API. Systems Manager Automation не знает результаты процессов оркестрации или вызовов сторонних API, поэтому результаты шагов неопределённы.

key -> (строка)

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

Regions -> (список)

Информация о регионах Amazon Web Services, на которые направлена предварительная оценка выполнения.

(строка)

TargetPreviews -> (список)

Информация, которая предоставляет предварительный просмотр воздействия запуска указанного исполняемого скрипта Automation.

(структура)

Информация о ресурсах, которые будут включены в фактическое выполнение скрипта, если оно будет запущено.

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

Количество ресурсов определённого типа, включённых в предварительную оценку выполнения.

TargetType -> (строка)

Тип ресурса, который был включён в предварительную оценку выполнения.

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

Информация об учётных записях Amazon Web Services, которые были включены в предварительную оценку выполнения.

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

Spec-Zone.ru

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