Spec-Zone.ru › AWS CLI v2

[ aws . deadline ]

search-steps

Описание

Ищет шаги.

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

Синтаксис

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

Идентификатор фермы для поиска шагов.

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

Идентификаторы очередей для поиска шагов.

(строка)

Синтаксис:

"string" "string" ...

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

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

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

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

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

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

Выходные данные

steps -> (список)

Шаги в поиске.

(структура)

Подробности поиска по шагу.

stepId -> (строка)

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

jobId -> (строка)

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

queueId -> (строка)

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

name -> (строка)

Имя шага.

lifecycleStatus -> (строка)

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

lifecycleStatusMessage -> (строка)

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

taskRunStatus -> (строка)

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

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

targetTaskRunStatus -> (строка)

Статус задачи, с которого следует начать работу над заданием.

taskRunStatusCounts -> (словарь)

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

key -> (строка)

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

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

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

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

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

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

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

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

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

parameters -> (список)

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

(структура)

Подробности параметра шага.

name -> (строка)

Имя параметра.

type -> (строка)

Тип данных параметра.

combination -> (строка)

Выражение сочетания для использования в поиске.

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

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

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

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

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

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

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