Spec-Zone.ru › AWS CLI v2

[ aws . cloudformation ]

list-change-sets

Описание

Возвращает идентификатор и состояние каждого активного набора изменений для стека. Например, CloudFormation перечисляет наборы изменений, находящиеся в состоянии CREATE_IN_PROGRESS или CREATE_PENDING.

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

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

Синтаксис

  list-change-sets
--stack-name <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-name (строка)

Имя или Amazon Resource Name (ARN) стека, для которого требуется перечислить наборы изменений.

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

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

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

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

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

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

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

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

Перечисление наборов изменений

Следующий пример list-change-sets отображает список ожидающих наборов изменений для указанного стека.

aws cloudformation list-change-sets \
   --stack-name my-stack

Вывод:

{
    "Summaries": [
        {
            "StackId": "arn:aws:cloudformation:us-west-2:123456789012:stack/my-stack/d0a825a0-e4cd-xmpl-b9fb-061c69e99204",
            "StackName": "my-stack",
            "ChangeSetId": "arn:aws:cloudformation:us-west-2:123456789012:changeSet/my-change-set/70160340-7914-xmpl-bcbf-128a1fa78b5d",
            "ChangeSetName": "my-change-set",
            "ExecutionStatus": "AVAILABLE",
            "Status": "CREATE_COMPLETE",
            "CreationTime": "2019-10-02T05:38:54.297Z"
        }
    ]
}

Вывод

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

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

(структура)

Структура ChangeSetSummary описывает набор изменений, его состояние и стек, с которым он связан.

StackId -> (строка)

Идентификатор стека, с которым связан набор изменений.

StackName -> (строка)

Имя стека, с которым связан набор изменений.

ChangeSetId -> (строка)

Идентификатор набора изменений.

ChangeSetName -> (строка)

Имя набора изменений.

ExecutionStatus -> (строка)

Если состояние выполнения набора изменений — AVAILABLE, вы можете выполнить набор изменений. Если вы не можете выполнить набор изменений, состояние указывает причину. Например, набор изменений может быть в состоянии UNAVAILABLE, потому что CloudFormation всё ещё создаёт его, или в состоянии OBSOLETE, потому что стек уже был обновлён.

Status -> (строка)

Состояние набора изменений, например CREATE_PENDING, CREATE_COMPLETE или FAILED.

StatusReason -> (строка)

Описание состояния набора изменений. Например, если ваш набор изменений находится в состоянии FAILED, CloudFormation отображает сообщение об ошибке.

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

Время начала создания набора изменений в формате UTC.

Description -> (строка)

Дескриптивная информация о наборе изменений.

IncludeNestedStacks -> (логическое значение)

Указывает текущее значение IncludeNestedStacks для набора изменений.

ParentChangeSetId -> (строка)

Идентификатор родительского набора изменений.

RootChangeSetId -> (строка)

Идентификатор корневого набора изменений.

ImportExistingResources -> (логическое значение)

Указывает, импортирует ли набор изменений ресурсы, которые уже существуют.

NextToken -> (строка)

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

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

Spec-Zone.ru

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