[ aws . quicksight ]
Поиск панелей
Описание
Ищет панели, принадлежащие пользователю.
Примечание
Данная операция является немедленной. Результаты – приблизительные и могут не отражать очень свежие обновления и изменения.См. также: Документацию API AWS
search-dashboards — это постраничная операция. Для получения всего набора результатов могут потребоваться несколько вызовов API. Вы можете отключить постраничный вывод, указав аргумент --no-paginate. При использовании --output text и аргумента --query в ответ на постраничный запрос, аргумент --query должен извлекать данные из результатов следующих выражений запроса: DashboardSummaryList
Синтаксис
search-dashboards
--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 (список)
Фильтры для поиска. В настоящее время вы можете искать только по имени пользователя, например, "Filters": [ { "Name": "QUICKSIGHT_USER", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east-1:1:user/default/UserName1" } ]
(структура)
Фильтр, применяемый при поиске панелей.
Оператор -> (строка)
Оператор сравнения, который вы хотите использовать в качестве фильтра, например, "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":"DASHBOARD_NAME", "Operator": "StringLike", "Value": "Test" . Оператор "StringLike" поддерживает только значение NAME DASHBOARD_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, указанным в качестве одного из владельцев или просматривающих панели, будут возвращены. Неявные разрешения из папок или групп не учитываются. -
DASHBOARD_NAME: Будут возвращены любые панели, имена которых имеют подстрочное совпадение с этим значением.
Значение -> (строка)
QUICKSIGHT_USER, которое вы хотите использовать в качестве фильтра, например, "Value": "arn:aws:quicksight:us-east-1:1:user/default/UserName1".Сокращенный синтаксис:
Operator=string,Name=string,Value=string ...
Синтаксис JSON:
[
{
"Operator": "StringEquals"|"StringLike",
"Name": "QUICKSIGHT_USER"|"QUICKSIGHT_VIEWER_OR_OWNER"|"DIRECT_QUICKSIGHT_VIEWER_OR_OWNER"|"QUICKSIGHT_OWNER"|"DIRECT_QUICKSIGHT_OWNER"|"DIRECT_QUICKSIGHT_SOLE_OWNER"|"DASHBOARD_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.
Вывод
СписокСводныхДанныхОПанелях -> (список)
Список панелей, которыми владеет пользователь, указанный в Filters в вашем запросе.
(структура)
Сводная информация о панели.
Arn -> (строка)
DashboardId -> (строка)
Имя -> (строка)
ДатаСоздания -> (временная метка)
ПоследнееОбновление -> (временная метка)
НомерОпубликованнойВерсии -> (длинное целое число)
ПоследняяОпубликованнаяДата -> (временная метка)
NextToken -> (строка)
Статус -> (целое число)
RequestId -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.