Spec-Zone.ru › AWS CLI v2

[ aws . deadline ]

search-tasks

Описание

Поиск задач.

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

Синтаксис

  search-tasks
--farm-id <value>
--queue-ids <value>
[--job-id <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 (строка)

ID фермы задач.

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

ID очередей для включения в поиск.

(строка)

Синтаксис:

"string" "string" ...

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

ID задания для поиска задач.

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

ID пользователя.

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
  • 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.

Вывод

tasks -> (список)

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

(структура)

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

taskId -> (строка)

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

stepId -> (строка)

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

jobId -> (строка)

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

queueId -> (строка)

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

runStatus -> (строка)

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

targetRunStatus -> (строка)

Статус выполнения, на который обновляется задача.

parameters -> (карта)

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

key -> (строка)

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

Типы данных для параметров задачи.

Примечание

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

int -> (строка)

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

float -> (строка)

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

string -> (строка)

Строка UTF-8.

path -> (строка)

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

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

Количество попыток неудачного выполнения и повторного выполнения задачи.

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

Дата и время начала выполнения ресурса.

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

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

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

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

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

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

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

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

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