describe-group
Описание
Возвращает информацию о конкретной группе.
См. также: Документацию API AWS
Синтаксис
describe-group
--directory-id <value>
[--other-attributes <value>]
[--realm <value>]
--sam-account-name <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]
Параметры
--directory-id (строка)
--other-attributes (список)
Один или несколько атрибутов, которые нужно вернуть для группы. Список поддерживаемых атрибутов см. в разделе Атрибуты данных службы каталогов.
(строка)
Синтаксис:
"string" "string" ...
--realm (строка)
Имя домена, связанное с группой.
Примечание
Этот параметр необязателен, поэтому вы можете возвращать группы за пределами домена управляемой Microsoft AD. Если значение не задано, возвращаются только группы управляемой Microsoft AD.
Это значение нечувствительно к регистру.
--sam-account-name (строка)
--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.
Примеры
Примечание
Чтобы использовать следующие примеры, необходимо установить и настроить AWS CLI. Дополнительную информацию см. в руководстве по началу работы в руководстве пользователя AWS CLI.
Если не указано иное, все примеры используют правила цитирования Unix-подобных систем. Эти примеры необходимо адаптировать к правилам цитирования вашей терминальной среды. Дополнительную информацию см. в разделе Использование кавычек со строками в руководстве пользователя AWS CLI.
Чтобы просмотреть подробности группы
В следующем describe-group примере извлекается информация о заданной группе в указанном каталоге.
aws ds-data describe-group \
--directory-id d-1234567890 \
--sam-account-name 'sales'
Вывод:
{
"DirectoryId": "d-1234567890",
"DistinguishedName": "CN=sales,OU=Users,OU=CORP,DC=corp,DC=example,DC=com",
"GroupScope": "Global",
"GroupType": "Security",
"Realm": "corp.example.com",
"SAMAccountName": "sales",
"SID": "S-1-2-34-5567891234-5678912345-67891234567-8912"
}
Дополнительную информацию см. в разделе Просмотр и обновление данных о группе AWS Managed Microsoft AD в руководстве по администрированию службы каталогов AWS.
Вывод
DirectoryId -> (строка)
DistinguishedName -> (строка)
GroupScope -> (строка)
GroupType -> (строка)
OtherAttributes -> (массив)
Значения атрибутов, возвращаемые для имен атрибутов, включенных в запрос.
ключ -> (строка)
значение -> (тегированный структурированный тип данных)
Тип данных атрибута. Каждое значение атрибута описывается как пара имя-значение. Имя - это имя схемы AD, а значение - само значение. Список поддерживаемых атрибутов см. в разделе Атрибуты данных службы каталогов.
Примечание
Это структурированный тип данных с тегами. Только один из следующих верхнеуровневых ключей может быть установлен:BOOL, N, S, SS.BOOL -> (булево)
Указывает, что тип значения атрибута - булево. Например:
"BOOL": trueN -> (целое число)
Указывает, что тип значения атрибута - число. Например:
"N": "16"S -> (строка)
Указывает, что тип значения атрибута - строка. Например:
"S": "S Group"SS -> (список)
Указывает, что тип значения атрибута - набор строк. Например:
"SS": ["sample_service_class/host.sample.com:1234/sample_service_name_1", "sample_service_class/host.sample.com:1234/sample_service_name_2"](строка)
Realm -> (строка)
SAMAccountName -> (строка)
SID -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.