Spec-Zone.ru › AWS CLI v2

[ aws . ssm-quicksetup ]

list-configurations

Описание

Возвращает конфигурации, развернутые Quick Setup в указанной учетной записи Amazon Web Services и регионе Amazon Web Services.

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

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

Синтаксис

  list-configurations
[--configuration-definition-id <value>]
[--filters <value>]
[--manager-arn <value>]
[--max-items <value>]
[--starting-token <value>]
[--cli-input-json | --cli-input-yaml]
[--page-size <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]

Параметры

--configuration-definition-id (строка)

Идентификатор определения конфигурации.

--filters (список)

Фильтрует результаты, возвращаемые запросом.

(структура)

Пара ключ-значение для фильтрации результатов.

Ключ -> (строка)

Ключ фильтра.

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

Значения для ключей фильтра.

(строка)

Сокращенный синтаксис:

Key=string,Values=string,string ...

Синтаксис JSON:

[
  {
    "Key": "string",
    "Values": ["string", ...]
  }
  ...
]

--manager-arn (строка)

ARN менеджера конфигурации.

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

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

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

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

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

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

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

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

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

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

--query (строка)

Запрос JMESPath для фильтрации данных ответа.

--profile (строка)

Использовать определенный профиль из файла учетных данных.

--region (строка)

Регион для использования. Переопределяет настройки конфигурации/среды.

--version (строка)

Отобразить версию этого инструмента.

--color (строка)

Включить/отключить цветной вывод.

  • включить
  • выключить
  • автоматически

--no-sign-request (булево)

Не подписывать запросы. Учетные данные не будут загружены, если этот аргумент предоставлен.

--ca-bundle (строка)

Обработка пакета сертификатов CA для проверки сертификатов SSL. Переопределяет настройки конфигурации/среды.

--cli-read-timeout (int)

Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию составляет 60 секунд.

--cli-connect-timeout (int)

Максимальное время подключения сокета в секундах. Если значение установлено в 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.

Вывод

ConfigurationsList -> (список)

Массив конфигураций.

(структура)

Детали конфигурации Quick Setup.

Account -> (строка)

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

ConfigurationDefinitionId -> (строка)

Идентификатор определения конфигурации.

CreatedAt -> (временная метка)

Дата и время создания конфигурации.

FirstClassParameters -> (карта)

Общие параметры и значения для определения конфигурации.

ключ -> (строка)

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

Id -> (строка)

Сгенерированный службой идентификатор конфигурации.

ManagerArn -> (строка)

ARN менеджера конфигурации.

Region -> (строка)

Регион Amazon Web Services, в котором была развернута конфигурация.

StatusSummaries -> (список)

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

(структура)

Резюмированное описание состояния.

LastUpdatedAt -> (временная метка)

Дата и время последнего обновления состояния.

Status -> (строка)

Текущее состояние.

StatusDetails -> (карта)

Подробная информация о состоянии.

ключ -> (строка)

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

StatusMessage -> (строка)

Применимо, возвращает информационное сообщение, относящееся к текущему состоянию и типу состояния объекта резюме состояния. Мы не рекомендуем реализовывать логику разбора по этому значению, так как возвращаемые сообщения могут отличаться по формату.

StatusType -> (строка)

Тип сводки состояния.

Type -> (строка)

Тип конфигурации Quick Setup.

TypeVersion -> (строка)

Версия типа Quick Setup, используемая.

NextToken -> (строка)

Маркер для запроса следующего набора элементов. Если дополнительных элементов нет, строка пустая.

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

Spec-Zone.ru

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