Spec-Zone.ru › AWS CLI v2

[ aws . license-manager-user-subscriptions ]

list-user-associations

Описание

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

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

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

Синтаксис

  list-user-associations
[--filters <value>]
--identity-provider <value>
--instance-id <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 (список)

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

  • Статус
  • Имя пользователя
  • Домен

(структура)

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

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

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

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

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

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

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

Сокращенная форма синтаксиса:

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

Синтаксис JSON:

[
  {
    "Attribute": "string",
    "Operation": "string",
    "Value": "string"
  }
  ...
]

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

Объект, определяющий детали поставщика удостоверений.

Примечание

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

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

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

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

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

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

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

Примечание

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

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

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

SecretId -> (строка)

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

DomainIpv4List -> (список)

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

(строка)

DomainName -> (строка)

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

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

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

Subnets -> (список)

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

(строка)

ActiveDirectoryType -> (строка)

Тип Active Directory — либо самостоятельный Active Directory, либо управляемый Amazon Web Services Active Directory.

DirectoryId -> (строка)

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

Синтаксис JSON:

{
  "ActiveDirectoryIdentityProvider": {
    "ActiveDirectorySettings": {
      "DomainCredentialsProvider": {
        "SecretsManagerCredentialsProvider": {
          "SecretId": "string"
        }
      },
      "DomainIpv4List": ["string", ...],
      "DomainName": "string",
      "DomainNetworkSettings": {
        "Subnets": ["string", ...]
      }
    },
    "ActiveDirectoryType": "SELF_MANAGED"|"AWS_MANAGED",
    "DirectoryId": "string"
  }
}

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

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

--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 версии 1, и двоичные значения должны передаваться буквально. При предоставлении содержимого из файла, которое отображается в двоичный блок 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.

Вывод

InstanceUserSummaries -> (список)

Метаданные, описывающие операцию ассоциации пользователей.

(структура)

Описывает пользователей экземпляра EC2, предоставляющих подписки на основе пользователя.

AssociationDate -> (строка)

Дата ассоциации пользователя с экземпляром EC2.

DisassociationDate -> (строка)

Дата отсоединения пользователя от экземпляра EC2.

Domain -> (строка)

Имя домена Active Directory, содержащего информацию о пользователе для подписки на продукт.

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, либо управляемый Amazon Web Services Active Directory.

DirectoryId -> (строка)

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

InstanceId -> (строка)

Идентификатор экземпляра EC2, предоставляющего подписки на основе пользователя.

InstanceUserArn -> (строка)

Идентификатор ресурса Amazon (ARN), идентифицирующий пользователя экземпляра.

Status -> (строка)

Состояние пользователя, связанного с экземпляром EC2.

StatusMessage -> (строка)

Сообщение о состоянии пользователей экземпляра EC2.

Username -> (строка)

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

NextToken -> (строка)

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

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

Spec-Zone.ru

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