Spec-Zone.ru › AWS CLI v2

[ aws . appstream ]

describe-directory-configs

Описание

Возвращает список, описывающий один или несколько указанных объектов Directory Config для AppStream 2.0, если предоставлены имена этих объектов. В противном случае описываются все объекты Directory Config в учетной записи. Эти объекты содержат конфигурационную информацию, необходимую для подключения флотов и создателей изображений к доменам Microsoft Active Directory.

Хотя синтаксис ответа в этом разделе включает пароль учетной записи, этот пароль не возвращается в фактическом ответе.

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

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

Синтаксис

  describe-directory-configs
[--directory-names <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]

Параметры

--directory-names (список)

Имена каталогов.

(строка)

Синтаксис:

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

Вывод

DirectoryConfigs -> (список)

Информация о конфигурациях каталогов. Обратите внимание, что хотя синтаксис ответа в этом разделе включает пароль учетной записи, этот пароль не возвращается в фактическом ответе.

(структура)

Описывает конфигурационную информацию, необходимую для подключения флотов и создателей изображений к доменам Microsoft Active Directory.

DirectoryName -> (строка)

Полное доменное имя каталога (например, corp.example.com).

OrganizationalUnitDistinguishedNames -> (список)

Уникальные имена организационных единиц для учетных записей компьютеров.

(строка)

ServiceAccountCredentials -> (структура)

Учетные данные для учетной записи службы, используемой флотом или создателем изображений для подключения к каталогу.

AccountName -> (строка)

Имя пользователя учетной записи. Эта учетная запись должна иметь следующие привилегии: создание объектов компьютеров, присоединение компьютеров к домену и изменение/сброс пароля для дочерних объектов компьютеров для указанных организационных единиц.

AccountPassword -> (строка)

Пароль учетной записи.

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

Время создания конфигурации каталога.

CertificateBasedAuthProperties -> (структура)

Свойства аутентификации на основе сертификатов, используемые для аутентификации идентификаторов пользователей SAML 2.0 Identity Provider (IdP) в домене Active Directory, подключенные к службам потоковой передачи. Режим падения включен по умолчанию, когда аутентификация на основе сертификатов Включена. Режим падения позволяет пользователям входить в систему, используя свой пароль домена Active Directory, если аутентификация на основе сертификатов не удалась, или для разблокировки заблокированной рабочей области. Enabled_no_directory_login_fallback включает аутентификацию на основе сертификатов, но не позволяет пользователям входить в систему, используя свой пароль домена Active Directory. Пользователи будут отключены для повторной аутентификации с помощью сертификатов.

Status -> (строка)

Статус свойств аутентификации на основе сертификатов.

CertificateAuthorityArn -> (строка)

ARN ресурса AWS Certificate Manager Private CA.

NextToken -> (строка)

Токен постраничного вывода для получения следующей страницы результатов для этой операции. Если больше страниц нет, это значение равно null.

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

Spec-Zone.ru

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