Spec-Zone.ru › AWS CLI v2

[ aws . ecs ]

list-task-definition-families

Описание

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

Вы можете отфильтровать семейства определений задач, которые не содержат никаких ACTIVE версий определений задач, установив параметр status в значение ACTIVE . Вы также можете отфильтровать результаты с помощью параметра familyPrefix.

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

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

Синтаксис

  list-task-definition-families
[--family-prefix <value>]
[--status <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]

Параметры

--family-prefix (строка)

Эта familyPrefix — строка, используемая для фильтрации результатов ListTaskDefinitionFamilies. Если вы укажете familyPrefix, будут возвращены только имена семейств определений задач, начинающиеся со строки familyPrefix.

--status (строка)

Статус семейства определений задач для фильтрации ListTaskDefinitionFamilies результатов. По умолчанию отображаются как ACTIVE, так и INACTIVE семейства определений задач. Если этот параметр установлен в значение ACTIVE, возвращаются только семейства определений задач, имеющие ACTIVE версию определения задачи. Если этот параметр установлен в значение INACTIVE, возвращаются только семейства определений задач, не имеющие никаких ACTIVE версий определений задач. Если вы используете постраничный вывод, убедитесь, что значение status сохраняется неизменным в каждом последующем запросе.

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

  • ACTIVE
  • INACTIVE
  • ALL

--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 (строка)

Переопределить адрес по умолчанию команды с помощью указанного адреса.

--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 (логическое значение)

Автоматически запрашивать параметры ввода командной строки.

--no-cli-auto-prompt (логическое значение)

Отключить автоматический запрос параметров ввода командной строки.

Примеры

Примечание

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

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

Пример 1: Список зарегистрированных семейств определений задач

Следующий list-task-definition-families пример перечисляет все зарегистрированные семейства определений задач.

aws ecs list-task-definition-families

Вывод:

{
    "families": [
        "node-js-app",
        "web-timer",
        "hpcc",
        "hpcc-c4-8xlarge"
    ]
}

Пример 2: Фильтрация зарегистрированных семейств определений задач

Следующий list-task-definition-families пример выводит версии определений задач, начинающиеся с «hpcc».

aws ecs list-task-definition-families --family-prefix hpcc

Вывод:

{
    "families": [
        "hpcc",
        "hpcc-c4-8xlarge"
    ]
}

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

Вывод

families -> (список)

Список имён семейств определений задач, соответствующих запросу ListTaskDefinitionFamilies.

(строка)

nextToken -> (строка)

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

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

Spec-Zone.ru

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