Spec-Zone.ru › AWS CLI v2

[ aws . datapipeline ]

query-objects

Описание

Запрашивает указанную конвейерную линию для получения имён объектов, соответствующих указанному набору условий.

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

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

Синтаксис

  query-objects
--pipeline-id <value>
--sphere <value>
[--objects-query <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]

Параметры

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

Идентификатор конвейерной линии.

--sphere (строка)

Указывает, относится ли запрос к компонентам или экземплярам. Возможные значения: COMPONENT , INSTANCE и ATTEMPT .

--objects-query (структура)

Запрос, определяющий возвращаемые объекты. Объект Query может содержать не более десяти селекторов. Условия в запросе ограничены полями String верхнего уровня в объекте. Эти фильтры могут применяться к компонентам, экземплярам и попыткам.

selectors -> (список)

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

(структура)

Сравнение, используемое для определения того, должен ли запрос вернуть этот объект.

fieldName -> (строка)

Имя поля, к которому будет применена операция. Имя поля — это часть определения поля в синтаксисе определения конвейерной линии, используемая API AWS Data Pipeline. Если поле не установлено в объекте, условие не выполняется.

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

Содержит логическую операцию для сравнения значения поля со значением.

type -> (строка)

Логическая операция, подлежащая выполнению: равняется (EQ ), ссылка равна (REF_EQ ), меньше или равно (LE ), больше или равно (GE ) или между (BETWEEN ). Ссылка равна (REF_EQ ) может использоваться только с ссылками на поля. Другие типы сравнения могут использоваться только с полями String. Типы сравнения, которые можно использовать, применяются только к определённым полям объекта, как подробно описано ниже.

Операторы сравнения EQ и REF_EQ действуют над следующими полями:

  • name
  • @sphere
  • parent
  • @componentParent
  • @instanceParent
  • @status
  • @scheduledStartTime
  • @scheduledEndTime
  • @actualStartTime
  • @actualEndTime

Операторы сравнения GE , LE и BETWEEN действуют над следующими полями:

  • @scheduledStartTime
  • @scheduledEndTime
  • @actualStartTime
  • @actualEndTime

Обратите внимание, что поля, начинающиеся с знака @, являются только для чтения и задаются веб-сервисом. При именовании полей следует выбирать имена, содержащие только буквенно-цифровые значения, так как символы могут быть зарезервированы службой AWS Data Pipeline. Пользовательские поля, которые вы добавляете в конвейерную линию, должны начинаться со строки “my”.

values -> (список)

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

(строка)

Синтаксис JSON:

{
  "selectors": [
    {
      "fieldName": "string",
      "operator": {
        "type": "EQ"|"REF_EQ"|"LE"|"GE"|"BETWEEN",
        "values": ["string", ...]
      }
    }
    ...
  ]
}

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

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

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

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

Вывод

ids -> (список)

Идентификаторы, соответствующие селекторам запроса.

(строка)

marker -> (строка)

Точка начала следующей страницы результатов. Для просмотра следующей страницы результатов необходимо снова вызвать QueryObjects со значением этого маркера. Если значение null, больше результатов нет.

hasMoreResults -> (логическое значение)

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

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

Spec-Zone.ru

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