Spec-Zone.ru › AWS CLI v2

[ aws . iam ]

list-access-keys

Описание

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

Хотя каждый пользователь ограничен небольшим числом ключей, вы всё равно можете постранично получать результаты, используя параметры MaxItems и Marker.

Если параметр UserName не указан, имя пользователя определяется неявно на основе идентификатора ключа доступа Amazon Web Services, используемого для подписи запроса. Если используется временный ключ доступа, то UserName требуется. Если пользователю назначен долгосрочный ключ, то UserName не требуется.

Эта операция работает с ключами доступа в рамках учетной записи Amazon Web Services. Если учетная запись Amazon Web Services не имеет связанных пользователей, корневой пользователь возвращает свои собственные идентификаторы ключей доступа, выполнив эту команду.

Примечание

Для обеспечения безопасности вашей учетной записи Amazon Web Services секретный ключ доступен только во время создания ключа и пользователя.

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

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

Синтаксис

  list-access-keys
[--user-name <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]

Параметры

--user-name (строка)

Имя пользователя.

Этот параметр позволяет (через шаблон регулярных выражений) строку символов, состоящую из буквенно-цифровых символов верхнего и нижнего регистра без пробелов. Вы также можете включить любой из следующих символов: _+=,.@-

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

--cli-auto-prompt (булево значение)

Автоматически запросить параметры ввода CLI.

--no-cli-auto-prompt (булево значение)

Отключить автоматический запрос параметров ввода CLI.

Примеры

Примечание

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

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

Чтобы перечислить идентификаторы ключей доступа для пользователя IAM

Следующая команда list-access-keys перечисляет идентификаторы ключей доступа для пользователя IAM с именем Bob.

aws iam list-access-keys \
    --user-name Bob

Вывод:

{
    "AccessKeyMetadata": [
        {
            "UserName": "Bob",
            "Status": "Active",
            "CreateDate": "2013-06-04T18:17:34Z",
            "AccessKeyId": "AKIAIOSFODNN7EXAMPLE"
        },
        {
            "UserName": "Bob",
            "Status": "Inactive",
            "CreateDate": "2013-06-06T20:42:26Z",
            "AccessKeyId": "AKIAI44QH8DHBEXAMPLE"
        }
    ]
}

Вы не можете перечислить секретные ключи доступа для пользователей IAM. Если секретные ключи доступа утеряны, необходимо создать новые ключи доступа с помощью команды create-access-keys.

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

Вывод

AccessKeyMetadata -> (список)

Список объектов, содержащих метаданные о ключах доступа.

(структура)

Содержит информацию об ключе доступа Amazon Web Services без его секретного ключа.

Этот тип данных используется в качестве элемента ответа в операции ListAccessKeys.

UserName -> (строка)

Имя пользователя IAM, с которым связан ключ.

AccessKeyId -> (строка)

Идентификатор этого ключа доступа.

Status -> (строка)

Состояние ключа доступа. Active означает, что ключ действителен для вызовов API; Inactive означает, что он не действителен.

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

Дата создания ключа доступа.

IsTruncated -> (булево значение)

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

Marker -> (строка)

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

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

Spec-Zone.ru

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