Spec-Zone.ru › AWS CLI v2

[ aws . ecs ]

list-attributes

Описание

Выводит атрибуты ресурсов Amazon ECS в заданном типе целевого объекта и кластере. Когда вы указываете тип целевого объекта и кластер, ListAttributes возвращает список объектов атрибутов, по одному для каждого атрибута каждого ресурса. Вы можете отфильтровать список результатов по имени атрибута, чтобы получить только результаты с этим именем. Вы также можете отфильтровать результаты по имени и значению атрибута. Например, вы можете посмотреть, какие контейнерные экземпляры в кластере работают с Linux AMI (ecs.os-type=linux).

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

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

Синтаксис

  list-attributes
[--cluster <value>]
--target-type <value>
[--attribute-name <value>]
[--attribute-value <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]

Параметры

--cluster (строка)

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

--target-type (строка)

Тип целевого объекта, для которого нужно вывести атрибуты.

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

  • container-instance

--attribute-name (строка)

Имя атрибута для фильтрации результатов.

--attribute-value (строка)

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

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

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

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

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

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

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

Примеры использования см. в разделе Постраничная загрузка в руководстве пользователя 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 в разделе «Использование кавычек со строками».

Для вывода контейнерных экземпляров, содержащих определенный атрибут

В следующем примере выводятся атрибуты контейнерных экземпляров, которые имеют атрибут stack=production в кластере по умолчанию.

aws ecs list-attributes \
    --target-type container-instance \
    --attribute-name stack \
    --attribute-value production \
    --cluster default

Вывод:

{
    "attributes": [
        {
            "name": "stack",
            "targetId": "arn:aws:ecs:us-west-2:130757420319:container-instance/1c3be8ed-df30-47b4-8f1e-6e68ebd01f34",
            "value": "production"
        }
    ]
}

Дополнительная информация приведена в разделе «Настройка контейнерного агента Amazon ECS» в руководстве разработчика Amazon ECS.

Вывод

attributes -> (список)

Список объектов атрибутов, соответствующих критериям запроса.

(структура)

Атрибут — это пара «имя-значение», связанная с объектом Amazon ECS. Используйте атрибуты для расширения модели данных Amazon ECS, добавляя пользовательские метаданные к вашим ресурсам. Дополнительная информация приведена в разделе «Атрибуты» в руководстве разработчика Amazon Elastic Container Service.

name -> (строка)

Имя атрибута. Имя атрибута должно содержать от 1 до 128 символов. Имя может содержать буквы (строчные и прописные), цифры, дефисы (-), подчёркивания (_), слэши (/), обратные слэши () или точки (.).

value -> (строка)

Значение атрибута. Значение атрибута должно содержать от 1 до 128 символов. Оно может содержать буквы (строчные и прописные), цифры, дефисы (-), подчёркивания (_), точки (.), знаки «@», слэши (/), обратные слэши (), двоеточия (:) или пробелы. Значение не может начинаться или заканчиваться пробелом.

targetType -> (строка)

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

targetId -> (строка)

Идентификатор целевого объекта. Вы можете указать короткий идентификатор ресурса или полный Amazon Resource Name (ARN).

nextToken -> (строка)

Значение nextToken для включения в последующий запрос ListAttributes. Когда результаты запроса ListAttributes превышают maxResults, это значение можно использовать для получения следующей страницы результатов. Это значение равно null, если больше результатов нет.

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

Spec-Zone.ru

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