[ aws . quicksight ]
search-data-sets
Описание
Используйте операцию SearchDataSets для поиска наборов данных, принадлежащих учетной записи.
См. также: Документацию API AWS
search-data-sets — это страничная операция. Для получения всего набора результатов могут быть вызваны несколько API-запросов. Вы можете отключить страничный вывод, указав аргумент --no-paginate. При использовании --output text и аргумента --query в ответном страничном сообщении аргумент --query должен извлекать данные из результатов следующих выражений запроса: DataSetSummaries
Синтаксис
search-data-sets
--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 -> (строка)
Оператор сравнения, который вы хотите использовать в качестве фильтра, например, "Operator": "StringEquals". Допустимые значения — "StringEquals" и "StringLike".
Если вы зададите оператор со значением "StringEquals", вам необходимо указать фильтр, связанный с правами собственности, в поле "NAME" и ARN пользователя или группы, наборы данных которых вы хотите найти, в поле "Value". Например, "Name":"QUICKSIGHT_OWNER", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east- 1:1:user/default/UserName1".
Если вы установите значение на "StringLike", вам нужно указать имя искомых наборов данных. Например, "Name":"DATASET_NAME", "Operator": "StringLike", "Value": "Test". Оператор "StringLike" поддерживает только значение NAME — DATASET_NAME.
Name -> (строка)
Имя значения, которое вы хотите использовать в качестве фильтра, например, "Name": "QUICKSIGHT_OWNER".
Допустимые значения определены следующим образом:
-
QUICKSIGHT_VIEWER_OR_OWNER: Укажите ARN пользователя или группы, и будут возвращены все наборы данных, в списке владельцев или просматривающих которых указан этот ARN. Учитываются неявные разрешения из папок или групп. -
QUICKSIGHT_OWNER: Укажите ARN пользователя или группы, и будут возвращены все наборы данных, в списке владельцев которых указан этот ARN. Учитываются неявные разрешения из папок или групп. -
DIRECT_QUICKSIGHT_SOLE_OWNER: Укажите ARN пользователя или группы, и будут возвращены все наборы данных, единственным владельцем которых является указанный ARN. Неявные разрешения из папок или групп не учитываются. -
DIRECT_QUICKSIGHT_OWNER: Укажите ARN пользователя или группы, и будут возвращены все наборы данных, владельцами которых является указанный ARN. Неявные разрешения из папок или групп не учитываются. -
DIRECT_QUICKSIGHT_VIEWER_OR_OWNER: Укажите ARN пользователя или группы, и будут возвращены все наборы данных, в списке владельцев или просматривающих которых указан этот ARN. Неявные разрешения из папок или групп не учитываются. -
DATASET_NAME: Будут возвращены все наборы данных, имена которых содержат подстроку, соответствующую этому значению.
Value -> (строка)
QUICKSIGHT_OWNER, которое вы хотите использовать в качестве фильтра, например, "Value": "arn:aws:quicksight:us-east-1:1:user/default/UserName1".Сокращённый синтаксис:
Operator=string,Name=string,Value=string ...
Синтаксис JSON:
[
{
"Operator": "StringEquals"|"StringLike",
"Name": "QUICKSIGHT_VIEWER_OR_OWNER"|"QUICKSIGHT_OWNER"|"DIRECT_QUICKSIGHT_VIEWER_OR_OWNER"|"DIRECT_QUICKSIGHT_OWNER"|"DIRECT_QUICKSIGHT_SOLE_OWNER"|"DATASET_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-auto-prompt (булево)
Автоматически запросить параметры входных данных CLI.
--no-cli-auto-prompt (булево)
Отключить автоматический запрос параметров входных данных CLI.
Вывод
DataSetSummaries -> (список)
Объект DataSetSummaries, возвращающий сводку набора данных.
(структура)
Сводка набора данных.
Arn -> (строка)
DataSetId -> (строка)
Name -> (строка)
CreatedTime -> (метка времени)
LastUpdatedTime -> (метка времени)
ImportMode -> (строка)
RowLevelPermissionDataSet -> (структура)
Настройка безопасности на уровне строк для набора данных.
Namespace -> (строка)
Arn -> (строка)
PermissionPolicy -> (строка)
DENY_ACCESS включён только для обратной совместимости.FormatVersion -> (строка)
Правила пользователей или групп, связанные с набором данных, содержащим разрешения для RLS.
По умолчанию, FormatVersion является VERSION_1. Когда FormatVersion является VERSION_1, UserName и GroupName необходимы. Когда FormatVersion является VERSION_2, UserARN и GroupARN необходимы, а Namespace не должно существовать.
Status -> (строка)
ENABLED. Если отключено, состояние - DISABLED.RowLevelPermissionTagConfigurationApplied -> (булево)
ColumnLevelPermissionRulesApplied -> (булево)
UseAs -> (строка)
NextToken -> (строка)
Status -> (целое число)
RequestId -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.