[ aws . quicksight ]
поиск-источников-данных
Описание
Используйте операцию SearchDataSources для поиска источников данных, принадлежащих учётной записи.
См. также: Документацию API AWS
search-data-sources — это постраничная операция. Для получения всего набора результатов может потребоваться несколько вызовов API. Вы можете отключить постраничный вывод, указав аргумент --no-paginate. При использовании --output text и аргумента --query в ответе с постраничным выводом, аргумент --query должен извлечь данные из результатов следующих выражений запроса: DataSourceSummaries
Синтаксис
search-data-sources
--aws-account-id <value>
--filters <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]
Параметры
--aws-account-id (строка)
--filters (список)
Фильтры для поиска.
(структура)
Фильтр, применяемый при поиске источников данных.
Оператор -> (строка)
Оператор сравнения, используемый в качестве фильтра, например, "Operator": "StringEquals". Допустимые значения — "StringEquals" и "StringLike".
Если вы установите значение оператора в "StringEquals", вам необходимо указать фильтр владения в поле "NAME" и arn пользователя или группы, чьи источники данных вы хотите найти, в поле "Value". Например, "Name":"DIRECT_QUICKSIGHT_OWNER", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east-1:1:user/default/UserName1".
Если вы установите значение в "StringLike", вам необходимо указать имя источников данных, которые вы ищете. Например, "Name":"DATASOURCE_NAME", "Operator": "StringLike", "Value": "Test". Оператор "StringLike" поддерживает только значение NAME DATASOURCE_NAME.
Имя -> (строка)
Имя значения, которое вы хотите использовать в качестве фильтра, например, "Name": "DIRECT_QUICKSIGHT_OWNER".
Допустимые значения определены следующим образом:
-
DIRECT_QUICKSIGHT_VIEWER_OR_OWNER: Укажите ARN пользователя или группы, и любые источники данных с этим ARN, указанным как один из владельцев или просматривающих источники данных, будут возвращены. Не учитываются неявные разрешения из папок или групп. -
DIRECT_QUICKSIGHT_OWNER: Укажите ARN пользователя или группы, и любые источники данных с этим ARN, указанным как один из владельцев, будут возвращены. Не учитываются неявные разрешения из папок или групп. -
DIRECT_QUICKSIGHT_SOLE_OWNER: Укажите ARN пользователя или группы, и любые источники данных с этим ARN, указанным как единственным владельцем источника данных, будут возвращены. Не учитываются неявные разрешения из папок или групп. -
DATASOURCE_NAME: Возвращаются любые источники данных, имена которых содержат подстроку, соответствующую указанному значению.
Значение -> (строка)
DIRECT_QUICKSIGHT_OWNER, которое вы хотите использовать в качестве фильтра, например, "Value": "arn:aws:quicksight:us-east-1:1:user/default/UserName1".Сокращённый синтаксис:
Operator=string,Name=string,Value=string ...
Синтаксис JSON:
[
{
"Operator": "StringEquals"|"StringLike",
"Name": "DIRECT_QUICKSIGHT_VIEWER_OR_OWNER"|"DIRECT_QUICKSIGHT_OWNER"|"DIRECT_QUICKSIGHT_SOLE_OWNER"|"DATASOURCE_NAME",
"Value": "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
- текст
- таблица
- 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 для вывода.
--cli-auto-prompt (булево)
Автоматически запросить параметры ввода CLI.
--no-cli-auto-prompt (булево)
Отключить автоматическое запроса параметров ввода CLI.
Вывод
DataSourceSummaries -> (список)
Объект DataSourceSummaries, который возвращает сводку источника данных.
(структура)
Объект DataSourceSummary, который возвращает сводку источника данных.
Arn -> (строка)
DataSourceId -> (строка)
Имя -> (строка)
Тип -> (строка)
CreatedTime -> (временная метка)
LastUpdatedTime -> (временная метка)
NextToken -> (строка)
Статус -> (целое число)
RequestId -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.