Spec-Zone.ru › AWS CLI v2

[ aws . identitystore ]

get-group-id

Описание

Извлекает GroupId в хранилище идентификации.

Примечание

Если у вас есть доступ администратора к учётной записи участника, вы можете использовать этот API из учётной записи участника. Узнайте о учётных записях участников в руководстве пользователя Organizations.

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

get-group-id использует значения типа документа. Типы документов следуют модели данных JSON, где допустимые значения: строки, числа, булевы значения, null, массивы и объекты. Для входных данных команды, параметры и вложенные параметры, помеченные типом document, должны быть предоставлены в формате JSON. Краткая запись не поддерживает типы документов.

Синтаксис

  get-group-id
--identity-store-id <value>
--alternate-identifier <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]

Параметры

--identity-store-id (строка)

Глобально уникальный идентификатор хранилища идентификации.

--alternate-identifier (структура помеченного объединения)

Уникальный идентификатор пользователя или группы, который не является основным идентификатором. Это значение может быть идентификатором из внешнего поставщика идентификации (IdP), связанного с пользователем, группой или уникальным атрибутом. Для уникального атрибута единственный допустимый путь — displayName.

Примечание

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

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

Идентификатор, выданный этому ресурсу внешним поставщиком идентификации.

Issuer -> (строка)

Издатель внешнего идентификатора.

Id -> (строка)

Идентификатор, выданный этому ресурсу внешним поставщиком идентификации.

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

Атрибут сущности, уникальный для конкретной сущности.

AttributePath -> (строка)

Строковое представление пути к заданному атрибуту или под-атрибуту. Поддерживает JMESPath.

AttributeValue -> (документ)

Значение атрибута. Это значение типа Document. Этот тип не поддерживается Java V1, Go V1 и более старыми версиями CLI.

Краткая запись:

ExternalId={Issuer=string,Id=string},UniqueAttribute={AttributePath=string}

Синтаксис JSON:

{
  "ExternalId": {
    "Issuer": "string",
    "Id": "string"
  },
  "UniqueAttribute": {
    "AttributePath": "string",
    "AttributeValue": {...}
  }
}

--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
  • text
  • table
  • yaml
  • yaml-stream

--query (строка)

Запрос JMESPath для использования в фильтрации данных ответа.

--profile (строка)

Использовать определенный профиль из файла учетных данных.

--region (строка)

Регион для использования. Переопределяет настройки конфигурации/среды.

--version (строка)

Показать версию этого инструмента.

--color (строка)

Включить/выключить цветной вывод.

  • on
  • off
  • auto

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

Вывод

GroupId -> (строка)

Идентификатор группы в хранилище идентификации.

IdentityStoreId -> (строка)

Глобально уникальный идентификатор хранилища идентификации.

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

Spec-Zone.ru

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