Spec-Zone.ru › AWS CLI v2

[ aws . quicksight ]

create-folder

Описание

Создаёт пустую общую папку.

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

Синтаксис

  create-folder
--aws-account-id <value>
--folder-id <value>
[--name <value>]
[--folder-type <value>]
[--parent-folder-arn <value>]
[--permissions <value>]
[--tags <value>]
[--sharing-model <value>]
[--cli-input-json | --cli-input-yaml]
[--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, в которой вы хотите создать папку.

--folder-id (строка)

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

--name (строка)

Имя папки.

--folder-type (строка)

Тип папки. По умолчанию, folderType это SHARED.

Возможные значения:

  • SHARED
  • RESTRICTED

--parent-folder-arn (строка)

Amazon Resource Name (ARN) родительской папки.

ParentFolderArn может быть null. Пустая parentFolderArn создаёт папку верхнего уровня.

--permissions (список)

Структура, описывающая принципалов и разрешения на уровне ресурсов папки.

Для указания отсутствия разрешений, опустите Permissions.

(структура)

Разрешение для ресурса.

Principal -> (строка)

Amazon Resource Name (ARN) принципала. Это может быть одно из следующего:

  • ARN пользователя или группы Amazon QuickSight, связанных с источником данных или набором данных. (Это распространённый случай.)
  • ARN пользователя, группы или пространства имён Amazon QuickSight, связанных с анализом, панелью мониторинга, шаблоном или темой. (Это распространённый случай.)
  • ARN корневого учётной записи Amazon Web Services: это IAM ARN, а не ARN QuickSight. Используйте этот вариант только для совместного использования ресурсов (шаблонов) между учётными записями Amazon Web Services. (Это менее распространено.)

Actions -> (список)

IAM действие для предоставления или отзыва разрешений.

(строка)

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

Principal=string,Actions=string,string ...

Синтаксис JSON:

[
  {
    "Principal": "string",
    "Actions": ["string", ...]
  }
  ...
]

--tags (список)

Теги для папки.

(структура)

Ключ или ключи пар ключ-значение для тега или тегов ресурса, назначенных ресурсу.

Key -> (строка)

Ключ тега.

Value -> (строка)

Значение тега.

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

Key=string,Value=string ...

Синтаксис JSON:

[
  {
    "Key": "string",
    "Value": "string"
  }
  ...
]

--sharing-model (строка)

Необязательный параметр, определяющий область совместного использования папки. Значение по умолчанию для этого параметра — ACCOUNT.

Возможные значения:

  • ACCOUNT
  • NAMESPACE

--cli-input-json | --cli-input-yaml (строка) Читает аргументы из предоставленной строки JSON. Строка JSON следует формату, предоставленному --generate-cli-skeleton. Если на командной строке указаны другие аргументы, эти значения переопределят значения, предоставленные JSON. Невозможно передавать произвольные двоичные значения с помощью предоставленного значения JSON, поскольку строка будет взята буквально. Это не может быть указано вместе с --cli-input-yaml.

--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.

Вывод

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

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

Arn -> (строка)

Amazon Resource Name (ARN) только что созданной папки.

FolderId -> (строка)

Идентификатор папки только что созданной папки.

RequestId -> (строка)

Идентификатор запроса для только что созданной папки.

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

Spec-Zone.ru

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