Spec-Zone.ru › AWS CLI v2

[ aws . ds-data ]

обновить-группу

Описание

Обновляет информацию о группе.

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

Синтаксис

  update-group
[--client-token <value>]
--directory-id <value>
[--group-scope <value>]
[--group-type <value>]
[--other-attributes <value>]
--sam-account-name <value>
[--update-type <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]

Параметры

--client-token (строка)

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

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

Если вы отправляете запрос с тем же токеном клиента, но изменяете один из других параметров в течение 8-часового окна идемпотентности, служба каталогов данных Active Directory возвращает ConflictException.

Примечание

Этот параметр является необязательным при использовании командной строки или SDK.

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

Идентификатор каталога, связанный с группой.

--group-scope (строка)

Область действия группы AD. Для получения подробностей, см. группы безопасности Active Directory.

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

  • DomainLocal
  • Global
  • Universal
  • BuiltinLocal

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

Тип группы AD. Для получения подробностей, см. тип группы безопасности Active Directory.

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

  • Distribution
  • Security

--other-attributes (массив)

Выражение, определяющее один или несколько атрибутов с типом данных и значением каждого атрибута.

ключ -> (строка)

значение -> (структура помеченных объединений)

Тип данных для атрибута. Каждое значение атрибута описывается как пара имя-значение. Имя — это имя схемы AD, а значение — само данные. Список поддерживаемых атрибутов см. в атрибутах службы каталогов данных.

Примечание

Это помеченная структура объединения. Можно задать только один из следующих ключей верхнего уровня: BOOL, N, S, SS.

BOOL -> (булево)

Указывает, что значение типа атрибута является булевым. Например:

"BOOL": true

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

Указывает, что значение типа атрибута — число. Например:

"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"]

(строка)

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

KeyName1=BOOL=boolean,N=long,S=string,SS=string,string,KeyName2=BOOL=boolean,N=long,S=string,SS=string,string

Синтаксис JSON:

{"string": {
      "BOOL": true|false,
      "N": long,
      "S": "string",
      "SS": ["string", ...]
    }
  ...}

--sam-account-name (строка)

Название группы.

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

Тип обновления, который нужно выполнить. Если значение для атрибута отсутствует, используйте ADD. В противном случае используйте REPLACE для изменения значения атрибута или REMOVE для очистки значения атрибута.

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

  • ADD
  • REPLACE
  • REMOVE

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

Обновление атрибута группы в каталоге

В следующем update-group примере обновляется указанный атрибут для указанной группы в указанном каталоге.

aws ds-data update-group \
    --directory-id d-1234567890 \
    --sam-account-name 'sales' \
    --update-type 'REPLACE' \
    --group-type 'Distribution'

Эта команда не генерирует вывод.

Дополнительную информацию см. в разделе Просмотр и обновление данных группы AWS Managed Microsoft AD в Руководстве администратора службы каталогов AWS.

Вывод

Нет

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

Spec-Zone.ru

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