Spec-Zone.ru › AWS CLI v2

[ aws . cloudformation ]

list-stack-set-operations

Описание

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

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

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

Синтаксис

  list-stack-set-operations
--stack-set-name <value>
[--call-as <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 (строка)

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

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

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

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

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

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

  • SELF
  • DELEGATED_ADMIN

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

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

Маркер для указания начальной точки постраничной загрузки. Это NextToken из ранее усеченного ответа.

Примеры использования см. в руководстве AWS Command Line Interface User Guide в разделе "Постраничная загрузка".

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

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

Примеры использования см. в руководстве AWS Command Line Interface User Guide в разделе "Постраничная загрузка".

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

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

Примеры использования см. в руководстве AWS Command Line Interface User Guide в разделе "Постраничная загрузка".

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

Если не указано иное, все примеры используют правила кавычек Unix-подобных систем. Эти примеры необходимо адаптировать к правилам кавычек вашей терминальной оболочки. См. раздел "Использование кавычек со строками" в руководстве AWS CLI User Guide.

Для перечисления операций с набором стеков

Следующий пример list-stack-set-operations отображает список последних операций с указанным набором стеков.

aws cloudformation list-stack-set-operations \
    --stack-set-name my-stack-set

Вывод:

{
    "Summaries": [
        {
            "OperationId": "35d45ebc-ed88-xmpl-ab59-0197a1fc83a0",
            "Action": "UPDATE",
            "Status": "SUCCEEDED",
            "CreationTimestamp": "2019-10-03T16:28:44.377Z",
            "EndTimestamp": "2019-10-03T16:42:08.607Z"
        },
        {
            "OperationId": "891aa98f-7118-xmpl-00b2-00954d1dd0d6",
            "Action": "UPDATE",
            "Status": "FAILED",
            "CreationTimestamp": "2019-10-03T15:43:53.916Z",
            "EndTimestamp": "2019-10-03T15:45:58.925Z"
        }
    ]
}

Вывод

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

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

(структура)

Структуры, содержащие сводную информацию об указанной операции.

OperationId -> (строка)

Уникальный идентификатор операции набора стеков.

Action -> (строка)

Тип операции: CREATE, UPDATE или DELETE. Операции создания и удаления влияют только на указанные экземпляры стеков, связанные с данным набором стеков. Операции обновления влияют как на сам набор стеков, так и на все связанные с ним экземпляры стеков.

Status -> (строка)

Общий статус операции.

  • FAILED: Операция превысила заданный порог ошибок. Значение порога ошибок, которое вы установили для операции, применяется для каждого региона во время операций создания и обновления стеков. Если количество неудачных стеков в регионе превышает порог ошибок, статус операции в этом регионе устанавливается в FAILED. Это, в свою очередь, устанавливает статус всей операции в FAILED, и CloudFormation отменяет операцию во всех оставшихся регионах.
  • QUEUED: [Права, управляемые службой] Для автоматических развертываний, требующих последовательности операций, операция помещается в очередь для выполнения. Дополнительную информацию см. в кодах статуса операций набора стеков в Руководстве пользователя CloudFormation.
  • RUNNING: Операция выполняется в данный момент.
  • STOPPED: Операция отменена пользователем.
  • STOPPING: Операция приостанавливается по запросу пользователя.
  • SUCCEEDED: Операция завершила создание или обновление всех указанных стеков без превышения порога ошибок для операции.

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

Время, в которое была начата операция. Обратите внимание, что время создания операции набора стеков может отличаться от времени создания отдельных стеков. Это связано с тем, что CloudFormation должна выполнить подготовительные работы для операции, такие как распределение работы по запрошенным регионам, прежде чем фактически создать первые стеки.

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

Время, в которое операция набора стеков завершилась во всех учетных записях и регионах, указанных в запросе. Обратите внимание, что это не обязательно означает, что операция набора стеков прошла успешно или даже была выполнена в каждой учетной записи или регионе.

StatusReason -> (строка)

Подробный статус операции.

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

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

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

Количество экземпляров стека, для которых операция StackSet завершилась неудачно.

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

Пользовательские параметры для того, как CloudFormation выполняет операцию набора стеков.

Дополнительную информацию о максимальном количестве одновременных учетных записей и пороге ошибок см. в разделе Опции операции набора стеков.

RegionConcurrencyType -> (строка)

Тип параллелизма развертывания операций StackSets в регионах, может быть параллельным или по одному региону за раз.

RegionOrder -> (список)

Порядок регионов, в которых вы хотите выполнить операцию над набором стеков.

(строка)

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

Количество учетных записей в каждом регионе, для которых эта операция может завершиться неудачно, прежде чем CloudFormation остановит операцию в этом регионе. Если операция останавливается в регионе, CloudFormation не пытается выполнить операцию в последующих регионах.

Условие: необходимо указать либо FailureToleranceCount, либо FailureTolerancePercentage (но не оба).

По умолчанию указано 0.

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

Процент учетных записей в каждом регионе, для которых эта операция может завершиться неудачно, прежде чем CloudFormation остановит операцию в этом регионе. Если операция останавливается в регионе, CloudFormation не пытается выполнить операцию в последующих регионах.

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

Условие: необходимо указать либо FailureToleranceCount, либо FailureTolerancePercentage, но не оба.

По умолчанию указано 0.

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

Максимальное количество учетных записей, в которых будет выполняться эта операция одновременно. Это может зависеть от значения FailureToleranceCount в зависимости от вашего ConcurrencyMode. MaxConcurrentCount не может быть более чем на единицу больше FailureToleranceCount, если вы используете STRICT_FAILURE_TOLERANCE.

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

Условие: необходимо указать либо MaxConcurrentCount, либо MaxConcurrentPercentage, но не оба.

По умолчанию указано 1.

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

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

При расчете количества учетных записей на основе указанного процента CloudFormation округляет вниз до ближайшего целого числа. Это верно, за исключением случаев, когда округление вниз даст ноль. В этом случае CloudFormation устанавливает значение как единицу.

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

Условие: необходимо указать либо MaxConcurrentCount, либо MaxConcurrentPercentage, но не оба.

По умолчанию указано 1.

ConcurrencyMode -> (строка)

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

  • STRICT_FAILURE_TOLERANCE: Этот параметр динамически снижает уровень параллелизма, чтобы гарантировать, что количество неудачных учетных записей никогда не превысит значение FailureToleranceCount +1. Начальный фактический уровень параллелизма устанавливается как меньшее из значений MaxConcurrentCount или FailureToleranceCount +1. Фактический уровень параллелизма затем уменьшается пропорционально количеству сбоев. Это поведение по умолчанию. Если порог ошибок или максимальное количество одновременных учетных записей заданы в процентах, поведение аналогичное.
  • SOFT_FAILURE_TOLERANCE: Этот параметр отсоединяет FailureToleranceCount от фактического уровня параллелизма. Это позволяет операциям набора стеков работать с уровнем параллелизма, заданным значением MaxConcurrentCount или MaxConcurrentPercentage, независимо от количества сбоев.

NextToken -> (строка)

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

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

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

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