Spec-Zone.ru › AWS CLI v2

[ aws . cloudformation ]

list-stacks

Описание

Возвращает сводную информацию о стеках, статус которых соответствует заданному значению StackStatusFilter. Сводная информация о удалённых стеках сохраняется в течение 90 дней после удаления стека. Если значение StackStatusFilter не указано, возвращается сводная информация обо всех стеках (включая существующие и удалённые).

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

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

Синтаксис

  list-stacks
[--stack-status-filter <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <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-status-filter (список)

Статус стека, используемый в качестве фильтра. Укажите один или несколько кодов статуса стека, чтобы отобразить только стеки с указанными кодами статуса. Полный список кодов статуса стека см. в параметре StackStatus типа данных Stack.

(строка)

Синтаксис:

"string" "string" ...

Where valid values are:
  CREATE_IN_PROGRESS
  CREATE_FAILED
  CREATE_COMPLETE
  ROLLBACK_IN_PROGRESS
  ROLLBACK_FAILED
  ROLLBACK_COMPLETE
  DELETE_IN_PROGRESS
  DELETE_FAILED
  DELETE_COMPLETE
  UPDATE_IN_PROGRESS
  UPDATE_COMPLETE_CLEANUP_IN_PROGRESS
  UPDATE_COMPLETE
  UPDATE_FAILED
  UPDATE_ROLLBACK_IN_PROGRESS
  UPDATE_ROLLBACK_FAILED
  UPDATE_ROLLBACK_COMPLETE_CLEANUP_IN_PROGRESS
  UPDATE_ROLLBACK_COMPLETE
  REVIEW_IN_PROGRESS
  IMPORT_IN_PROGRESS
  IMPORT_COMPLETE
  IMPORT_ROLLBACK_IN_PROGRESS
  IMPORT_ROLLBACK_FAILED
  IMPORT_ROLLBACK_COMPLETE

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

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

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

Примеры использования см. в разделе Постраничный вывод в руководстве пользователя 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
  • текст
  • таблица
  • 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.

Примеры

Примечание

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

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

Для отображения AWS CloudFormation стеков

Следующая list-stacks команда отображает сводную информацию обо всех стеках, имеющих статус CREATE_COMPLETE:

aws cloudformation list-stacks --stack-status-filter CREATE_COMPLETE

Вывод:

[
    {
        "StackId": "arn:aws:cloudformation:us-east-1:123456789012:stack/myteststack/466df9e0-0dff-08e3-8e2f-5088487c4896",
        "TemplateDescription": "AWS CloudFormation Sample Template S3_Bucket: Sample template showing how to create a publicly accessible S3 bucket. **WARNING** This template creates an S3 bucket. You will be billed for the AWS resources used if you create a stack from this template.",
        "StackStatusReason": null,
        "CreationTime": "2013-08-26T03:27:10.190Z",
        "StackName": "myteststack",
        "StackStatus": "CREATE_COMPLETE"
    }
]

Вывод

StackSummaries -> (список)

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

(структура)

Тип данных StackSummary

StackId -> (строка)

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

StackName -> (строка)

Имя, связанное со стеком.

TemplateDescription -> (строка)

Описание шаблона, использованного для создания стека.

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

Время создания стека.

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

Время последнего обновления стека. Это поле будет возвращено только в том случае, если стек был обновлён как минимум один раз.

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

Время удаления стека.

StackStatus -> (строка)

Текущий статус стека.

StackStatusReason -> (строка)

Сообщение об успехе/неудачи, связанное со статусом стека.

ParentId -> (строка)

Для вложенных стеков — стеков, созданных в качестве ресурсов для другого стека — идентификатор стека непосредственного родителя этого стека. Для стеков первого уровня вложенности корневой стек также является родительским стеком.

Дополнительную информацию см. в разделе Встраивание стеков в другие стеки с использованием вложенных стеков в руководстве пользователя CloudFormation.

RootId -> (строка)

Для вложенных стеков — стеков, созданных в качестве ресурсов для другого стека — идентификатор стека верхнего уровня, к которому в конечном итоге принадлежит вложенный стек.

Дополнительную информацию см. в разделе Встраивание стеков в другие стеки с использованием вложенных стеков в руководстве пользователя CloudFormation.

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

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

StackDriftStatus -> (строка)

Статус фактической конфигурации стека по сравнению с ожидаемой конфигурацией шаблона.

  • DRIFTED: Стек отличается от ожидаемой конфигурации шаблона. Стек считается отклонившимся, если один или несколько его ресурсов отклонились.
  • NOT_CHECKED: CloudFormation ещё не проверил, отличается ли стек от ожидаемой конфигурации шаблона.
  • IN_SYNC: Фактическая конфигурация стека соответствует ожидаемой конфигурации шаблона.
  • UNKNOWN: Это значение зарезервировано для будущего использования.

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

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

NextToken -> (строка)

Если размер вывода превышает 1 МБ, строка, идентифицирующая следующую страницу стеков. Если дополнительных страниц нет, это значение равно null.

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

Spec-Zone.ru

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