Spec-Zone.ru › AWS CLI v2

[ aws . iam ]

list-virtual-mfa-devices

Описание

Выводит список виртуальных устройств MFA, определённых в учётной записи Amazon Web Services, по статусу привязки. Если статус привязки не указан, операция возвращает список всех виртуальных устройств MFA. Статус привязки может быть Assigned , Unassigned , или Any .

Примечание

Операции перечисления ресурсов IAM возвращают подмножество доступных атрибутов ресурса. Например, эта операция не возвращает метки, хотя они являются атрибутом возвращаемого объекта. Чтобы просмотреть информацию о метках виртуального устройства MFA, см. ListMFADeviceTags .

Вы можете использовать параметры MaxItems и Marker для постраничного отображения результатов.

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

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

Синтаксис

  list-virtual-mfa-devices
[--assignment-status <value>]
[--max-items <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <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]

Параметры

--assignment-status (строка)

Статус (Unassigned или Assigned ) устройств для вывода списка. Если статус AssignmentStatus не указан, операция по умолчанию устанавливается на Any, что отображает как привязанные, так и не привязанные виртуальные устройства MFA.

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

  • Assigned
  • Unassigned
  • Any

--max-items (целое число)

Общее количество элементов для возврата в выводе команды. Если общее количество доступных элементов превышает указанное значение, в выводе команды предоставляется NextToken. Для возобновления постраничного отображения укажите значение NextToken в аргументе starting-token последующей команды. Не используйте элемент ответа NextToken напрямую вне AWS CLI.

Примеры использования см. в разделе Постраничное отображение в Руководстве пользователя AWS Command Line Interface .

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

--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 ввода.

Примеры

Примечание

Для использования следующих примеров, необходимо установить и настроить AWS CLI. Дополнительную информацию см. в руководстве по началу работы с Руководством пользователя AWS CLI .

Если не указано иное, все примеры используют правила цитирования, подобные unix-подобным. Эти примеры потребуется адаптировать к правилам цитирования вашей терминальной оболочки. См. Использование кавычек со строками в Руководстве пользователя AWS CLI .

Для вывода списка виртуальных устройств MFA

Следующая list-virtual-mfa-devices команда выводит список виртуальных устройств MFA, которые были настроены для текущей учетной записи.

aws iam list-virtual-mfa-devices

Вывод:

{
    "VirtualMFADevices": [
        {
            "SerialNumber": "arn:aws:iam::123456789012:mfa/ExampleMFADevice"
        },
        {
            "SerialNumber": "arn:aws:iam::123456789012:mfa/Fred"
        }
    ]
}

Дополнительную информацию см. в разделе Включение виртуального устройства многофакторной аутентификации (MFA) в Руководстве пользователя AWS IAM.

Вывод

VirtualMFADevices -> (список)

Список виртуальных устройств MFA в текущей учетной записи, которые соответствуют значению AssignmentStatus, переданному в запросе.

(структура)

Содержит информацию о виртуальном устройстве MFA.

SerialNumber -> (строка)

Серийный номер, связанный с VirtualMFADevice.

Base32StringSeed -> (бинарные данные)

Базовое 32-строчное семя, определённое в соответствии со спецификацией RFC3548. Base32StringSeed закодировано в формате base32.

QRCodePNG -> (бинарные данные)

Изображение QR-кода в формате PNG, которое кодирует otpauth://totp/$virtualMFADeviceName@$AccountName?secret=$Base32String, где $virtualMFADeviceName — один из аргументов вызова создания. AccountName — имя пользователя, если задано (иначе — идентификатор учетной записи), а Base32String — семя в формате base32. Значение Base32String закодировано в формате base64.

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

Пользователь IAM, связанный с этим виртуальным устройством MFA.

Path -> (строка)

Путь к пользователю. Для получения дополнительной информации о путях, см. идентификаторы IAM в руководстве Руководство по IAM.

ARN политики, используемой для установки границ разрешений для пользователя.

UserName -> (строка)

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

UserId -> (строка)

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

Arn -> (строка)

Amazon Resource Name (ARN), идентифицирующий пользователя. Для получения дополнительной информации об ARN и о том, как использовать ARN в политиках, см. Идентификаторы IAM в руководстве Руководство по IAM.

CreateDate -> (метка времени)

Дата и время создания пользователя в формате ISO 8601.

PasswordLastUsed -> (метка времени)

Дата и время последнего использования пароля пользователя для входа на веб-сайт Amazon Web Services в формате ISO 8601. Список веб-сайтов Amazon Web Services, которые регистрируют время последнего входа пользователя, см. в разделе «Отчеты о учетных данных» в руководстве Руководство по IAM. Если пароль используется более одного раза в течение пяти минут, в этом поле возвращается только первое использование. Если поле имеет значение null (нет значения), это означает, что пользователь никогда не входил в систему с помощью пароля. Это может быть из-за:

  • У пользователя никогда не было пароля.
  • Пароль существует, но не использовался с момента начала отслеживания этой информации IAM 20 октября 2014 года.

Значение null не означает, что у пользователя никогда не было пароля. Кроме того, если у пользователя в настоящее время нет пароля, но был раньше, в этом поле содержится дата и время последнего использования пароля.

Это значение возвращается только в операциях GetUser и ListUsers.

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

Для получения дополнительной информации о границах разрешений, см. Границы разрешений для идентификаторов IAM в руководстве Руководство по IAM.

PermissionsBoundaryType -> (строка)

Тип использования границ разрешений, указывающий на тип ресурса IAM, используемого в качестве границ разрешений для сущности. Этот тип данных может иметь только значение Policy.

PermissionsBoundaryArn -> (строка)

ARN политики, используемой для установки границ разрешений для пользователя или роли.

Tags -> (список)

Список тегов, связанных с пользователем. Для получения дополнительной информации об использовании тегов, см. Использование тегов для ресурсов IAM в руководстве Руководство по IAM.

(структура)

Структура, представляющая пользовательские метаданные, которые можно связать с ресурсом IAM. Для получения дополнительной информации об использовании тегов, см. Использование тегов для ресурсов IAM в руководстве Руководство по IAM.

Key -> (строка)

Имя ключа, которое можно использовать для поиска или получения связанного значения. Например, Department или Cost Center являются распространенными вариантами.

Value -> (строка)

Значение, связанное с этим тегом. Например, теги с именем ключа Department могут иметь значения, такие как Human Resources, Accounting и Support. Теги с именем ключа Cost Center могут иметь значения, состоящие из числа, связанного с различными центрами затрат в вашей компании. Как правило, многие ресурсы имеют теги с одинаковым именем ключа, но с разными значениями.

Примечание

Amazon Web Services всегда интерпретирует тег Value как одну строку. Если вам нужно сохранить массив, вы можете сохранить значения, разделенные запятыми, в строке. Однако вы должны интерпретировать значение в своём коде.

EnableDate -> (метка времени)

Дата и время активации виртуального устройства MFA.

Tags -> (список)

Список тегов, прикрепленных к виртуальному устройству MFA. Для получения дополнительной информации об использовании тегов, см. Использование тегов для ресурсов IAM в руководстве Руководство по IAM.

(структура)

Структура, представляющая пользовательские метаданные, которые можно связать с ресурсом IAM. Для получения дополнительной информации об использовании тегов, см. Использование тегов для ресурсов IAM в руководстве Руководство по IAM.

Key -> (строка)

Имя ключа, которое можно использовать для поиска или получения связанного значения. Например, Department или Cost Center являются распространёнными вариантами.

Value -> (строка)

Значение, связанное с этим тегом. Например, теги с именем ключа Department могут иметь значения, такие как Human Resources, Accounting и Support. Теги с именем ключа Cost Center могут иметь значения, состоящие из числа, связанного с различными центрами затрат в вашей компании. Как правило, многие ресурсы имеют теги с одинаковым именем ключа, но с разными значениями.

Примечание

Amazon Web Services всегда интерпретирует тег Value как одну строку. Если вам нужно сохранить массив, вы можете сохранить значения, разделенные запятыми, в строке. Однако вы должны интерпретировать значение в своём коде.

IsTruncated -> (логическое значение)

Флаг, указывающий на наличие дополнительных элементов для возврата. Если результаты были усечены, можно выполнить последующий запрос с параметром Marker, чтобы получить дополнительные элементы. Обратите внимание, что IAM может вернуть меньше, чем указано в MaxItems количестве результатов, даже если доступно больше результатов. Рекомендуется проверять IsTruncated после каждого вызова, чтобы убедиться, что вы получаете все результаты.

Marker -> (строка)

Когда IsTruncated равно true, этот элемент присутствует и содержит значение, используемое для параметра Marker в последующем запросе.

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

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

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