Spec-Zone.ru › AWS CLI v2

[ aws . quicksight ]

Поиск анализов

Описание

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

Примечание

Данная операция является несинхронной. Результаты представляют собой наилучшее усилие и могут не отражать совсем недавние обновления и изменения.

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

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

Синтаксис

  search-analyses
--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 (строка)

Идентификатор учётной записи Amazon Web Services, содержащей анализы, которые вы ищете.

--filters (список)

Структура фильтров поиска, которые вы хотите применить к поиску.

(структура)

Фильтр, применяемый при поиске одного или нескольких анализов.

Operator -> (строка)

Оператор сравнения, который вы хотите использовать в качестве фильтра, например, "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":"ANALYSIS_NAME", "Operator": "StringLike", "Value": "Test". Оператор "StringLike" поддерживает только значение NAME ANALYSIS_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, указанным как один из владельцев или просматривателей анализов, будут возвращены. Неявные разрешения из папок или групп не учитываются.
  • ANALYSIS_NAME: Будут возвращены все анализы, имена которых содержат подстроку, соответствующую данному значению.

Value -> (строка)

Значение указанного элемента, в данном случае 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"|"ANALYSIS_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
  • text
  • таблица
  • 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.

Вывод

AnalysisSummaryList -> (список)

Метаданные, описывающие анализы, которые вы искали.

(структура)

Метаданные сводки, описывающие анализ.

Arn -> (строка)

Amazon Resource Name (ARN) для анализа.

AnalysisId -> (строка)

Идентификатор анализа. Этот идентификатор отображается в URL.

Name -> (строка)

Название анализа. Это имя отображается в консоли Amazon QuickSight.

Status -> (строка)

Последний известный статус анализа.

CreatedTime -> (метка времени)

Время создания анализа.

LastUpdatedTime -> (метка времени)

Время последнего обновления анализа.

NextToken -> (строка)

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

Status -> (целое число)

HTTP-статус запроса.

RequestId -> (строка)

Идентификатор запроса Amazon Web Services для этой операции.

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

Spec-Zone.ru

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