Spec-Zone.ru › AWS CLI v2

[ aws . ecs ]

list-task-definitions

Описание

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

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

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

Синтаксис

  list-task-definitions
[--family-prefix <value>]
[--status <value>]
[--sort <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 (строка)

Полное имя семейства для фильтрации результатов ListTaskDefinitions. Указание familyPrefix ограничивает перечень определений задач версиями определений задач, принадлежащими этому семейству.

--status (строка)

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

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

  • ACTIVE
  • INACTIVE
  • DELETE_IN_PROGRESS

--sort (строка)

Порядок сортировки результатов. Допустимые значения: ASC и DESC. По умолчанию определения задач (ASC) перечисляются лексикографически по имени семейства и в порядке возрастания номера версии, так что самые новые определения задач в семействе перечисляются последними. Установка этого параметра в значение DESC меняет порядок сортировки по имени семейства и номеру версии. В результате самые новые определения задач в семействе перечисляются первыми.

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

  • ASC
  • DESC

--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
  • таблица
  • 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 для вывода.

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

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

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

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

Примеры

Примечание

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

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

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

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

aws ecs list-task-definitions

Вывод:

{
    "taskDefinitionArns": [
        "arn:aws:ecs:us-west-2:123456789012:task-definition/sleep300:2",
        "arn:aws:ecs:us-west-2:123456789012:task-definition/sleep360:1",
        "arn:aws:ecs:us-west-2:123456789012:task-definition/wordpress:3",
        "arn:aws:ecs:us-west-2:123456789012:task-definition/wordpress:4",
        "arn:aws:ecs:us-west-2:123456789012:task-definition/wordpress:5",
        "arn:aws:ecs:us-west-2:123456789012:task-definition/wordpress:6"
    ]
}

Пример 2: Отображение зарегистрированных определений задач в семействе

Следующий пример list-task-definitions отображает версии определений задач указанного семейства.

aws ecs list-task-definitions --family-prefix wordpress

Вывод:

{
    "taskDefinitionArns": [
        "arn:aws:ecs:us-west-2:123456789012:task-definition/wordpress:3",
        "arn:aws:ecs:us-west-2:123456789012:task-definition/wordpress:4",
        "arn:aws:ecs:us-west-2:123456789012:task-definition/wordpress:5",
        "arn:aws:ecs:us-west-2:123456789012:task-definition/wordpress:6"
    ]
}

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

Вывод

taskDefinitionArns -> (список)

Список записей ARN Amazon Resource Name (ARN) определений задач для ListTaskDefinitions запроса.

(строка)

nextToken -> (строка)

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

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

Spec-Zone.ru

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