Spec-Zone.ru › AWS CLI v2

[ aws . license-manager-user-subscriptions ]

list-identity-providers

Описание

Отображает поставщиков идентификации Active Directory для подписок на основе пользователей.

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

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

Синтаксис

  list-identity-providers
[--filters <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]

Параметры

--filters (список)

Вы можете использовать следующие фильтры для оптимизации результатов:

  • Продукт
  • DirectoryId

(структура)

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

Атрибут -> (строка)

Имя атрибута, используемого в качестве фильтра.

Операция -> (строка)

Тип поиска (например, eq, geq, leq)

Значение -> (строка)

Значение фильтра.

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

Attribute=string,Operation=string,Value=string ...

Синтаксис JSON:

[
  {
    "Attribute": "string",
    "Operation": "string",
    "Value": "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 (int)

Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет выполняться без блокировки и без таймаута. Значение по умолчанию составляет 60 секунд.

--cli-connect-timeout (int)

Максимальное время подключения сокета в секундах. Если значение установлено в 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.

Вывод

IdentityProviderSummaries -> (список)

Массив ресурсов IdentityProviderSummary, содержащих подробности о поставщиках идентификации Active Directory, соответствующих критериям запроса.

(структура)

Описывает поставщика идентификации.

FailureMessage -> (строка)

Сообщение об ошибке, связанное с поставщиком идентификации.

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

Ресурс IdentityProvider содержит информацию о поставщике идентификации.

Примечание

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

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

Ресурс ActiveDirectoryIdentityProvider содержит настройки и другие сведения о конкретном поставщике идентификации Active Directory.

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

Ресурс ActiveDirectorySettings содержит сведения об Active Directory, включая сведения о сетевом доступе, такие как имя домена и IP-адреса, и поставщика учетных данных для администрирования пользователей.

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

Указывает на ресурс CredentialsProvider, содержащий сведения о поставщике учетных данных для администрирования пользователей.

Примечание

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

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

Идентифицирует секрет Secrets Manager, содержащий учетные данные, необходимые для администрирования пользователей в Active Directory.

SecretId -> (строка)

Идентификатор секрета Secrets Manager, содержащего учетные данные.

DomainIpv4List -> (список)

Список IP-адресов IPv4 домена, используемых для Active Directory.

(строка)

DomainName -> (строка)

Имя домена Active Directory.

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

Ресурс DomainNetworkSettings содержит массив подсетей, применимых для Active Directory.

Subnets -> (список)

Содержит список подсетей, применимых для домена Active Directory.

(строка)

ActiveDirectoryType -> (строка)

Тип Active Directory — либо собственный Active Directory, либо Active Directory Amazon Web Services.

DirectoryId -> (строка)

Идентификатор каталога для поставщика идентификации Active Directory.

IdentityProviderArn -> (строка)

Amazon Resource Name (ARN) поставщика идентификации.

Product -> (строка)

Имя продукта подписки на основе пользователя.

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

Ресурс Settings содержит сведения о настройках конфигурации продукта зарегистрированного поставщика идентификации, такие как подсети для развертывания VPC-точек конечного доступа.

SecurityGroupId -> (строка)

Идентификатор группы безопасности, разрешающий входящее TCP-соединение по порту 1688 между ресурсами вашей VPC и VPC-точкой конечного доступа для серверов активации.

Subnets -> (список)

Подсети, определенные для зарегистрированного поставщика идентификации.

(строка)

Status -> (строка)

Статус поставщика идентификации.

NextToken -> (строка)

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

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

Spec-Zone.ru

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