Spec-Zone.ru › AWS CLI v2

[ aws . deadline ]

Поиск задач

Описание

Ищет задачи.

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

Синтаксис

  search-jobs
--farm-id <value>
--queue-ids <value>
[--filter-expressions <value>]
[--sort-expressions <value>]
--item-offset <value>
[--page-size <value>]
[--cli-input-json | --cli-input-yaml]
[--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]

Параметры

--farm-id (строка)

Идентификатор фермы задач.

--queue-ids (список)

Идентификатор очереди для поиска задач.

(строка)

Синтаксис:

"string" "string" ...

--filter-expressions (структура)

Выражение фильтра, AND или OR , для поиска среди группы поисковых строк в ресурсе. Можно использовать две группы в скобках ().

filters -> (список)

Фильтры для поиска.

(структура помеченного объединения)

Тип фильтра поиска.

Примечание

Это структура помеченного объединения. Только один из следующих ключей верхнего уровня может быть задан: dateTimeFilter, parameterFilter, searchTermFilter, stringFilter, groupFilter.

dateTimeFilter -> (структура)

Фильтры по дате и времени.

name -> (строка)

Имя поля даты и времени для фильтрации.

operator -> (строка)

Тип сравнения для фильтрации результатов.

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

Дата и время.

parameterFilter -> (структура)

Фильтры по параметрам.

name -> (строка)

Имя параметра для фильтрации.

operator -> (строка)

Тип сравнения для фильтрации результатов.

value -> (строка)

Значение параметра.

searchTermFilter -> (структура)

Фильтры по заданному поисковому термину.

searchTerm -> (строка)

Искомый термин.

matchType -> (строка)

Указывает, как Deadline Cloud сопоставляет ваш поисковый термин с результатами. Если вы не укажете matchType, по умолчанию используется FUZZY_MATCH.

  • FUZZY_MATCH - Сопоставление, если часть поискового термина найдена в результате.
  • CONTAINS - Сопоставление, если точный поисковый термин содержится в результате.

stringFilter -> (структура)

Фильтры по строке.

name -> (строка)

Имя поля для поиска.

operator -> (строка)

Тип сравнения для поиска.

value -> (строка)

Искомая строка.

groupFilter -> (структура)

Фильтры по группам.

filters -> (список)

Фильтры для поиска.

(структура помеченного объединения)

Тип фильтра поиска.

Примечание

Это структура помеченного объединения. Только один из следующих ключей верхнего уровня может быть задан: dateTimeFilter, parameterFilter, searchTermFilter, stringFilter, groupFilter.

dateTimeFilter -> (структура)

Фильтры по дате и времени.

name -> (строка)

Имя поля даты и времени для фильтрации.

operator -> (строка)

Тип сравнения для фильтрации результатов.

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

Дата и время.

parameterFilter -> (структура)

Фильтры по параметрам.

name -> (строка)

Имя параметра для фильтрации.

operator -> (строка)

Тип сравнения для фильтрации результатов.

value -> (строка)

Значение параметра.

searchTermFilter -> (структура)

Фильтры по заданному поисковому термину.

searchTerm -> (строка)

Искомый термин.

matchType -> (строка)

Указывает, как Deadline Cloud сопоставляет ваш поисковый термин с результатами. Если вы не укажете matchType, по умолчанию используется FUZZY_MATCH.

  • FUZZY_MATCH - Сопоставление, если часть поискового термина найдена в результате.
  • CONTAINS - Сопоставление, если точный поисковый термин содержится в результате.

stringFilter -> (структура)

Фильтры по строке.

name -> (строка)

Имя поля для поиска.

operator -> (строка)

Тип сравнения для поиска.

value -> (строка)

Искомая строка.

( … рекурсивно … )

operator -> (строка)

Операторы для включения в поиск.

operator -> (строка)

Операторы для включения в поиск.

Синтаксис JSON:

{
  "filters": [
    {
      "dateTimeFilter": {
        "name": "string",
        "operator": "EQUAL"|"NOT_EQUAL"|"GREATER_THAN_EQUAL_TO"|"GREATER_THAN"|"LESS_THAN_EQUAL_TO"|"LESS_THAN",
        "dateTime": timestamp
      },
      "parameterFilter": {
        "name": "string",
        "operator": "EQUAL"|"NOT_EQUAL"|"GREATER_THAN_EQUAL_TO"|"GREATER_THAN"|"LESS_THAN_EQUAL_TO"|"LESS_THAN",
        "value": "string"
      },
      "searchTermFilter": {
        "searchTerm": "string",
        "matchType": "FUZZY_MATCH"|"CONTAINS"
      },
      "stringFilter": {
        "name": "string",
        "operator": "EQUAL"|"NOT_EQUAL"|"GREATER_THAN_EQUAL_TO"|"GREATER_THAN"|"LESS_THAN_EQUAL_TO"|"LESS_THAN",
        "value": "string"
      },
      "groupFilter": {
        "filters": [
          {
            "dateTimeFilter": {
              "name": "string",
              "operator": "EQUAL"|"NOT_EQUAL"|"GREATER_THAN_EQUAL_TO"|"GREATER_THAN"|"LESS_THAN_EQUAL_TO"|"LESS_THAN",
              "dateTime": timestamp
            },
            "parameterFilter": {
              "name": "string",
              "operator": "EQUAL"|"NOT_EQUAL"|"GREATER_THAN_EQUAL_TO"|"GREATER_THAN"|"LESS_THAN_EQUAL_TO"|"LESS_THAN",
              "value": "string"
            },
            "searchTermFilter": {
              "searchTerm": "string",
              "matchType": "FUZZY_MATCH"|"CONTAINS"
            },
            "stringFilter": {
              "name": "string",
              "operator": "EQUAL"|"NOT_EQUAL"|"GREATER_THAN_EQUAL_TO"|"GREATER_THAN"|"LESS_THAN_EQUAL_TO"|"LESS_THAN",
              "value": "string"
            },
            "groupFilter": { ... recursive ... }
          }
          ...
        ],
        "operator": "AND"|"OR"
      }
    }
    ...
  ],
  "operator": "AND"|"OR"
}

--sort-expressions (список)

Поисковые термины для ресурса.

(структура помеченного объединения)

Искомые ресурсы.

Примечание

Это структура помеченного объединения. Только один из следующих ключей верхнего уровня может быть задан: userJobsFirst, fieldSort, parameterSort.

userJobsFirst -> (структура)

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

userIdentityId -> (строка)

Идентификатор пользователя.

fieldSort -> (структура)

Параметры сортировки по полю.

sortOrder -> (строка)

Порядок сортировки по полю.

name -> (строка)

Имя поля.

parameterSort -> (структура)

Параметры сортировки по параметру.

sortOrder -> (строка)

Порядок сортировки по параметру.

name -> (строка)

Имя параметра для сортировки.

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

userJobsFirst={userIdentityId=string},fieldSort={sortOrder=string,name=string},parameterSort={sortOrder=string,name=string} ...

Синтаксис JSON:

[
  {
    "userJobsFirst": {
      "userIdentityId": "string"
    },
    "fieldSort": {
      "sortOrder": "ASCENDING"|"DESCENDING",
      "name": "string"
    },
    "parameterSort": {
      "sortOrder": "ASCENDING"|"DESCENDING",
      "name": "string"
    }
  }
  ...
]

--item-offset (целое число)

Определяет, на сколько пунктов в прокручиваемом списке начать возвращать результаты.

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

Указывает количество элементов на страницу для ресурса.

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

--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-auto-prompt (булево)

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

--no-cli-auto-prompt (булево)

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

Вывод

jobs -> (список)

Задачи в поиске.

(структура)

Подробности поиска задач.

jobId -> (строка)

Идентификатор задачи.

queueId -> (строка)

Идентификатор очереди.

name -> (строка)

Название задачи.

lifecycleStatus -> (строка)

Статус жизненного цикла.

lifecycleStatusMessage -> (строка)

Сообщение о статусе жизненного цикла.

taskRunStatus -> (строка)

Статус выполнения задачи для задачи.

  • PENDING – ожидается и ждёт ресурсов.
  • READY – готова к обработке.
  • ASSIGNED – назначена и будет выполнена следующей на рабочем узле.
  • SCHEDULED – запланирована для выполнения на рабочем узле.
  • INTERRUPTING – прерывается.
  • RUNNING – выполняется на рабочем узле.
  • SUSPENDED – задача приостановлена.
  • CANCELED – задача отменена.
  • FAILED – задача завершилась с ошибкой.
  • SUCCEEDED – задача завершилась успешно.

targetTaskRunStatus -> (строка)

Статус задачи, с которого нужно начать выполнение задачи.

taskRunStatusCounts -> (карта)

Количество задач, выполняемых для задачи.

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

значение -> (целое число)

priority -> (целое число)

Приоритет задачи.

maxFailedTasksCount -> (целое число)

Количество ошибок задач до того, как задача прекратит выполнение и будет помечена как FAILED.

maxRetriesPerTask -> (целое число)

Максимальное количество попыток для задачи.

createdBy -> (строка)

Пользователь или система, создавшая этот ресурс.

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

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

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

Дата и время завершения работы ресурса.

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

Дата и время запуска ресурса.

jobParameters -> (карта)

Параметры задачи.

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

значение -> (структура помеченного союза)

Подробности параметров задачи.

Примечание

Это структура помеченного союза. Можно установить только один из следующих ключей верхнего уровня: int, float, string, path.

int -> (строка)

Целое число со знаком, представленное в виде строки.

float -> (строка)

Число двойной точности IEEE-754 с плавающей запятой, представленное в виде строки.

string -> (строка)

Строка UTF-8.

path -> (строка)

Путь к файловой системе, представленный в виде строки.

maxWorkerCount -> (целое число)

Максимальное количество узлов рабочих процессов, которые могут одновременно обрабатывать задачу. Когда достигнуто maxWorkerCount , больше рабочих процессов не будут назначены для обработки задачи, даже если флоты, назначенные для очереди задачи, имеют доступных рабочих процессов.

Вы не можете установить maxWorkerCount в 0. Если вы установите его в -1, максимальное количество рабочих процессов не ограничено.

Если вы не укажете maxWorkerCount , по умолчанию используется -1.

sourceJobId -> (строка)

Идентификатор задачи для исходной задачи.

nextItemOffset -> (целое число)

Следующая инкрементная точка отсчета после определенного itemOffset.

totalResults -> (целое число)

Общее количество результатов в поиске.

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

Spec-Zone.ru

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