Поиск списков
Описание
Ищет списки (записи об активе в определенное время) в Amazon DataZone.
См. также: Документацию API AWS
search-listings — это операция с постраничной передачей. Для получения всего набора результатов могут быть выполнены несколько вызовов API. Вы можете отключить постраничную передачу, указав аргумент --no-paginate. При использовании --output text и аргумента --query в ответе с постраничной передачей, аргумент --query должен извлекать данные из результатов следующих выражений запроса: items
Синтаксис
search-listings
[--additional-attributes <value>]
--domain-identifier <value>
[--filters <value>]
[--search-in <value>]
[--search-text <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]
Параметры
--additional-attributes (список)
Указывает дополнительные атрибуты для поиска.
(строка)
Синтаксис:
"string" "string" ...
Where valid values are:
FORMS
TIME_SERIES_DATA_POINT_FORMS
--domain-identifier (строка)
--filters (структура помеченного объединения)
Указывает фильтры для поиска списков.
Примечание
Это структура помеченного объединения. Можно задать только один из следующих верхнеуровневых ключей:and, filter, or.
and -> (список)
Оператор «и» в фильтре поиска Amazon DataZone.
(структура помеченного объединения)
Оператор фильтра поиска в Amazon DataZone.
Примечание
Это структура помеченного объединения. Можно задать только один из следующих верхнеуровневых ключей:and, filter, or.
and -> (список)
Оператор «и» в фильтре поиска Amazon DataZone.
(… рекурсивно …)
filter -> (структура)
Фильтр поиска в Amazon DataZone.
attribute -> (строка)
value -> (строка)
or -> (список)
Оператор «или» в фильтре поиска Amazon DataZone.
(… рекурсивно …)
filter -> (структура)
Фильтр поиска в Amazon DataZone.
attribute -> (строка)
value -> (строка)
or -> (список)
Оператор «или» в фильтре поиска Amazon DataZone.
(структура помеченного объединения)
Оператор фильтра поиска в Amazon DataZone.
Примечание
Это структура помеченного объединения. Можно задать только один из следующих верхнеуровневых ключей:and, filter, or.
and -> (список)
Оператор «и» в фильтре поиска Amazon DataZone.
(… рекурсивно …)
filter -> (структура)
Фильтр поиска в Amazon DataZone.
attribute -> (строка)
value -> (строка)
or -> (список)
Оператор «или» в фильтре поиска Amazon DataZone.
(… рекурсивно …)
Синтаксис JSON:
{
"and": [
{
"and": [
{ ... recursive ... }
...
],
"filter": {
"attribute": "string",
"value": "string"
},
"or": [
{ ... recursive ... }
...
]
}
...
],
"filter": {
"attribute": "string",
"value": "string"
},
"or": [
{
"and": [
{ ... recursive ... }
...
],
"filter": {
"attribute": "string",
"value": "string"
},
"or": [
{ ... recursive ... }
...
]
}
...
]
}
--search-in (список)
Детали поиска.
(структура)
Детали поиска.
attribute -> (строка)
Сокращенный синтаксис:
attribute=string ...
Синтаксис JSON:
[
{
"attribute": "string"
}
...
]
--search-text (строка)
--sort (структура)
Указывает способ сортировки результатов поиска.
attribute -> (строка)
order -> (строка)
Сокращенный синтаксис:
attribute=string,order=string
Синтаксис JSON:
{
"attribute": "string",
"order": "ASCENDING"|"DESCENDING"
}
--cli-input-json | --cli-input-yaml (строка) Читает аргументы из предоставленной строки JSON. Строка JSON соответствует формату, указанному в --generate-cli-skeleton. Если другие аргументы указаны в командной строке, эти значения переопределят значения, предоставленные JSON. Невозможно передавать произвольные двоичные значения с помощью предоставленного значения JSON, так как строка будет воспринята буквально. Это не может быть указано вместе с --cli-input-yaml.
--starting-token (строка)
Токен для указания места начала постраничной передачи. Это NextToken из ранее усеченного ответа.
Примеры использования см. в разделе «Постраничная передача» в руководстве пользователя AWS CLI.
--page-size (целое число)
Размер каждой страницы для получения в вызове AWS-сервиса. Это не влияет на количество элементов, возвращаемых в выводе команды. Установка меньшего размера страницы приводит к большему количеству вызовов AWS-сервиса, извлекая меньше элементов в каждом вызове. Это может помочь предотвратить таймаут вызовов AWS-сервиса.
Примеры использования см. в разделе «Постраничная передача» в руководстве пользователя AWS CLI.
--max-items (целое число)
Общее количество элементов для возврата в выводе команды. Если общее количество доступных элементов больше указанного значения, в выводе команды предоставляется NextToken. Для продолжения постраничной передачи укажите значение NextToken в аргументе starting-token последующей команды. **Не** используйте элемент ответа NextToken напрямую за пределами AWS CLI.
Примеры использования см. в разделе «Постраничная передача» в руководстве пользователя AWS CLI.
--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 (int)
Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет блокирующим и не будет ограничено по времени. Значение по умолчанию — 60 секунд.
--cli-connect-timeout (int)
Максимальное время подключения сокета в секундах. Если значение установлено в 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.
Вывод
items -> (список)
Результаты действия SearchListings.
(структура помеченного объединения)
Подробности результатов действия SearchListings.
Примечание
Это структура помеченного объединения. Только один из следующих ключей верхнего уровня может быть задан:assetListing, dataProductListing.assetListing -> (структура)
Список активов, включённых в результаты действия SearchListings.
additionalAttributes -> (структура)
Дополнительные атрибуты актива, опубликованного в каталоге Amazon DataZone.
forms -> (строка)
latestTimeSeriesDataPointForms -> (список)
Формы последних точек данных временного ряда, включённые в дополнительные атрибуты актива.
(структура)
Резюме формы точек данных временного ряда.
contentSummary -> (строка)
formName -> (строка)
id -> (строка)
timestamp -> (метка времени)
typeIdentifier -> (строка)
typeRevision -> (строка)
createdAt -> (метка времени)
description -> (строка)
entityId -> (строка)
entityRevision -> (строка)
entityType -> (строка)
glossaryTerms -> (список)
Словари терминов, прикреплённые к активу инвентаризации.
(структура)
Подробности термина из глоссария, прикреплённого к активу инвентаризации.
name -> (строка)
shortDescription -> (строка)
listingCreatedBy -> (строка)
listingId -> (строка)
listingRevision -> (строка)
listingUpdatedBy -> (строка)
name -> (строка)
owningProjectId -> (строка)
dataProductListing -> (структура)
Список продуктов данных.
additionalAttributes -> (структура)
Дополнительные атрибуты актива продукта данных.
forms -> (строка)
createdAt -> (метка времени)
description -> (строка)
entityId -> (строка)
entityRevision -> (строка)
glossaryTerms -> (список)
Словари терминов актива продукта данных.
(структура)
Подробности термина из глоссария, прикреплённого к активу инвентаризации.
name -> (строка)
shortDescription -> (строка)
items -> (список)
Данные актива продукта данных.
(структура)
Результаты сводки продукта данных.
glossaryTerms -> (список)
Словари терминов списка продукта данных.
(структура)
Подробности термина из глоссария, прикреплённого к активу инвентаризации.
name -> (строка)
shortDescription -> (строка)
listingId -> (строка)
listingRevision -> (строка)
listingCreatedBy -> (строка)
listingId -> (строка)
listingRevision -> (строка)
listingUpdatedBy -> (строка)
name -> (строка)
owningProjectId -> (строка)
nextToken -> (строка)
MaxResults, или если вы явно указали значение для MaxResults, которое меньше количества результатов, ответ включает маркер пагинации под названием NextToken. Вы можете указать это значение NextToken в последующем вызове SearchListings, чтобы получить следующий набор результатов.totalMatchCount -> (целое число)
© Copyright 2025, Amazon Web Services. Created using Sphinx.