Spec-Zone.ru › AWS CLI v2

[ aws . quicksight ]

Поиск папок

Описание

Ищет подпапки в папке.

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

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

Синтаксис

  search-folders
--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 (список)

Фильтры для поиска. В настоящее время можно искать только по ARN родительской папки. Например, "Filters": [ { "Name": "PARENT_FOLDER_ARN", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east-1:1:folder/folderId" } ] .

(структура)

Фильтр для поиска папки Amazon QuickSight.

Оператор -> (строка)

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

Значение -> (строка)

Значение указанного элемента (в данном примере, PARENT_FOLDER_ARN ), которое нужно использовать в качестве фильтра. Например, "Value": "arn:aws:quicksight:us-east-1:1:folder/folderId" .

Сокращенный синтаксис:

Operator=string,Name=string,Value=string ...

Синтаксис JSON:

[
  {
    "Operator": "StringEquals"|"StringLike",
    "Name": "PARENT_FOLDER_ARN"|"DIRECT_QUICKSIGHT_OWNER"|"DIRECT_QUICKSIGHT_SOLE_OWNER"|"DIRECT_QUICKSIGHT_VIEWER_OR_OWNER"|"QUICKSIGHT_OWNER"|"QUICKSIGHT_VIEWER_OR_OWNER"|"FOLDER_NAME",
    "Value": "string"
  }
  ...
]

--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
  • текст
  • таблица
  • 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.

Вывод

Статус -> (целое число)

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

СписокFolderSummary -> (список)

Структура, содержащая все папки в учетной записи Amazon Web Services. Эта структура предоставляет основную информацию о папках.

(структура)

Резюме информации о существующей папке Amazon QuickSight.

Arn -> (строка)

Amazon Resource Name (ARN) папки.

FolderId -> (строка)

Идентификатор папки.

Имя -> (строка)

Отображаемое имя папки.

ТипПапки -> (строка)

Тип папки.

ДатаСоздание -> (метка времени)

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

ПоследнееОбновление -> (метка времени)

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

МодельОбмена -> (строка)

Сфера обмена папки.

NextToken -> (строка)

Маркер для следующего набора результатов или null, если больше результатов нет.

RequestId -> (строка)

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

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

Spec-Zone.ru

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