Spec-Zone.ru › AWS CLI v2

[ aws . cloudformation ]

list-stack-set-operation-results

Описание

Возвращает сводную информацию о результатах операции с набором стеков.

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

list-stack-set-operation-results является постраничной операцией. Для получения всего набора результатов может потребоваться несколько API-вызовов. Вы можете отключить постраничность, предоставив аргумент --no-paginate. При использовании --output text и аргумента --query в постраничном ответе, аргумент --query должен извлечь данные из результатов следующих выражений запроса: Summaries

Синтаксис

  list-stack-set-operation-results
--stack-set-name <value>
--operation-id <value>
[--call-as <value>]
[--filters <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--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]

Параметры

--stack-set-name (строка)

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

--operation-id (строка)

Идентификатор операции с набором стеков.

--call-as (строка)

[Права управления сервисом] Указывает, действуете ли вы как администратор учетной записи в учетной записи управления организацией или как делегированный администратор в учетной записи участника.

По умолчанию, задан SELF. Используйте SELF для наборов стеков с правами самообслуживания.

  • Если вы вошли в учетную запись управления, укажите SELF.
  • Если вы вошли в учетную запись делегированного администратора, укажите DELEGATED_ADMIN. Ваша учетная запись Amazon Web Services должна быть зарегистрирована как делегированный администратор в учетной записи управления. Дополнительные сведения см. в руководстве пользователя CloudFormation в разделе «Регистрация делегированного администратора».

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

  • SELF
  • DELEGATED_ADMIN

--filters (список)

Фильтр для применения к результатам операции.

(структура)

Статус, по которому фильтруются результаты операции.

Имя -> (строка)

Тип фильтра, который нужно применить.

Значения -> (строка)

Значение для фильтрации.

Сокращенная форма синтаксиса:

Name=string,Values=string ...

Синтаксис JSON:

[
  {
    "Name": "OPERATION_RESULT_STATUS",
    "Values": "string"
  }
  ...
]

--cli-input-json | --cli-input-yaml (строка) Считывает аргументы из предоставленной JSON-строки. JSON-строка соответствует формату, предоставленному --generate-cli-skeleton. Если другие аргументы указаны в командной строке, эти значения перепишут значения, предоставленные JSON. Невозможно передать произвольные двоичные значения с помощью значения JSON, так как строка будет интерпретироваться буквально. Это может не быть указано вместе с --cli-input-yaml.

--starting-token (строка)

Токен для указания точки начала постраничного отображения. Это NextToken из ранее укороченного ответа.

Примеры использования см. в руководстве пользователя AWS CLI в разделе «Постраничный вывод».

--page-size (целое число)

Размер каждой страницы для получения в вызове AWS-сервиса. Это не влияет на количество элементов, возвращаемых в выводе команды. Установка меньшего размера страницы приводит к большему количеству вызовов AWS-сервиса, извлекая меньше элементов в каждом вызове. Это может помочь предотвратить таймауты вызовов AWS-сервиса.

Примеры использования см. в руководстве пользователя AWS CLI в разделе «Постраничный вывод».

--max-items (целое число)

Общее количество элементов для возврата в выводе команды. Если общее количество доступных элементов превышает указанное значение, в выводе команды предоставляется NextToken. Для возобновления постраничного отображения укажите значение NextToken в аргументе starting-token последующей команды. **Не** используйте элемент ответа NextToken напрямую вне AWS CLI.

Примеры использования см. в руководстве пользователя AWS CLI в разделе «Постраничный вывод».

--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 для вывода.

--cli-auto-prompt (логическое значение)

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

--no-cli-auto-prompt (логическое значение)

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

Примеры

Примечание

Для использования следующих примеров необходимо установить и настроить AWS CLI. Дополнительные сведения см. в руководстве пользователя AWS CLI в разделе «Начало работы».

За исключением случаев, когда сказано иначе, все примеры используют правила цитирования Unix-подобных оболочек. Эти примеры необходимо адаптировать к правилам цитирования вашей оболочки. См. раздел «Использование кавычек со строками» в руководстве пользователя AWS CLI.

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

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

aws cloudformation list-stack-set-operation-results \
    --stack-set-name enable-config \
    --operation-id 35d45ebc-ed88-xmpl-ab59-0197a1fc83a0

Вывод:

{
    "Summaries": [
        {
            "Account": "223456789012",
            "Region": "us-west-2",
            "Status": "SUCCEEDED",
            "AccountGateResult": {
                "Status": "SKIPPED",
                "StatusReason": "Function not found: arn:aws:lambda:eu-west-1:223456789012:function:AWSCloudFormationStackSetAccountGate"
            }
        },
        {
            "Account": "223456789012",
            "Region": "ap-south-1",
            "Status": "CANCELLED",
            "StatusReason": "Cancelled since failure tolerance has exceeded"
        }
    ]
}

Примечание: Статус SKIPPED для AccountGateResult ожидается для успешных операций, если не создана функция шлюза учетной записи.

Вывод

Сводки -> (список)

Список структур StackSetOperationResultSummary, содержащих информацию о результатах указанной операции для учётных записей и регионов Amazon Web Services, включённых в операцию.

(структура)

Структура, содержащая информацию о результатах указанной операции для заданной учётной записи в заданном регионе.

Учётная запись -> (строка)

[Права самообслуживания] Название учётной записи Amazon Web Services для данного результата операции.

Регион -> (строка)

Название региона Amazon Web Services для данного результата операции.

Статус -> (строка)

Статус результата операции над набором стеков для заданной учётной записи в заданном регионе.

  • CANCELLED : Операция в указанной учётной записи и регионе была отменена. Это может произойти, если пользователь остановил операцию над набором стеков или был превышен порог допустимых сбоев для операции над набором стеков.
  • FAILED : Операция в указанной учётной записи и регионе завершилась с ошибкой. Если операция над набором стеков завершается с ошибкой в достаточном количестве учётных записей в регионе, это может привести к превышению порога допустимых сбоев для операции над набором стеков в целом.
  • RUNNING : Операция в указанной учётной записи и регионе выполняется в данный момент.
  • PENDING : Операция в указанной учётной записи и регионе ещё не началась.
  • SUCCEEDED : Операция в указанной учётной записи и регионе успешно завершена.

Описание статуса -> (строка)

Причина присвоения статуса результата.

Результат проверки учётной записи -> (структура)

Результаты функции проверки учётной записи, вызываемой CloudFormation, если таковая имеется, прежде чем приступить к операциям над набором стеков в учётной записи.

Статус -> (строка)

Статус функции проверки учётной записи.

  • SUCCEEDED : Функция проверки учётной записи определила, что учётная запись и регион соответствуют всем требованиям для выполнения операции над набором стеков. CloudFormation продолжает операцию над стеком в этой учётной записи и регионе.
  • FAILED : Функция проверки учётной записи определила, что учётная запись и регион не соответствуют требованиям для выполнения операции над набором стеков. CloudFormation отменяет операцию над набором стеков в этой учётной записи и регионе и устанавливает статус результата операции над набором стеков для этой учётной записи и региона в FAILED.
  • SKIPPED : CloudFormation пропустила вызов функции проверки учётной записи для этой учётной записи и региона по одной из следующих причин:
    • Для учётной записи и региона не была указана функция проверки учётной записи. CloudFormation продолжает операцию над набором стеков в этой учётной записи и регионе.
    • У учётной записи для администрирования набора стеков отсутствуют разрешения на вызов функции. CloudFormation продолжает операцию над набором стеков в этой учётной записи и регионе.
    • В стеке нет необходимости или невозможно выполнить никаких действий. CloudFormation пропускает операцию над набором стеков в этой учётной записи и регионе.

Описание статуса -> (строка)

Причина присвоения статуса проверки учётной записи этой учётной записи и региону для операции над набором стеков.

Идентификатор организационной единицы -> (строка)

[Права службы] Корневой идентификатор организации или идентификаторы организационных единиц (OU), которые вы указали для DeploymentTargets.

NextToken -> (строка)

Если запрос не возвращает все результаты, NextToken устанавливается в токен. Для получения следующего набора результатов вызовите ListOperationResults снова и присвойте этот токен параметру NextToken объекта запроса. Если больше результатов нет, NextToken устанавливается в null.

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

Spec-Zone.ru

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