list-ssh-public-keys
Описание
Возвращает информацию об общедоступных ключах SSH, связанных с указанным пользователем IAM. Если таких ключей нет, операция возвращает пустой список.
Общедоступные ключи SSH, возвращаемые этой операцией, используются только для аутентификации пользователя IAM в репозитории CodeCommit. Дополнительную информацию об использовании ключей SSH для аутентификации в репозитории CodeCommit см. в разделе «Настройка CodeCommit для подключений SSH» в руководстве пользователя CodeCommit.
Хотя каждый пользователь ограничен небольшим количеством ключей, вы все равно можете постраничивать результаты, используя параметры MaxItems и Marker.
См. также: Документацию API AWS
list-ssh-public-keys — это постраничная операция. Для получения всего набора результатов могут быть выполнены несколько вызовов API. Вы можете отключить постраничный вывод, указав аргумент --no-paginate. При использовании --output text и аргумента --query в ответе, содержащем постраничную информацию, аргумент --query должен извлекать данные из результатов следующих запросов: SSHPublicKeys
Синтаксис
list-ssh-public-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 (строка)
Имя пользователя IAM, для которого необходимо перечислить общедоступные ключи SSH. Если не указано, поле UserName определяется неявно на основе используемого ключа доступа Amazon Web Services для подписания запроса.
Этот параметр допускает (через регулярное выражение) строку символов, состоящую из букв и цифр верхнего и нижнего регистра без пробелов. Вы также можете включить следующие символы: _+=,.@-
--max-items (целое число)
Общее количество элементов для возврата в выводе команды. Если общее количество доступных элементов превышает указанное значение, в выводе команды предоставляется NextToken. Для возобновления постраничного вывода укажите значение NextToken в аргументе starting-token последующей команды. Не используйте элемент ответа NextToken напрямую вне AWS CLI.
Примеры использования см. в разделе Постраничный вывод в руководстве пользователя AWS CLI.
--cli-input-json | --cli-input-yaml (строка) Считывает аргументы из предоставленной строки JSON. Строка JSON соответствует формату, указанному в --generate-cli-skeleton. Если другие аргументы предоставлены в командной строке, эти значения переопределят значения, предоставленные в JSON. Невозможно передавать произвольные двоичные значения с помощью предоставленного значения JSON, так как строка будет воспринята буквально. Это не может быть указано вместе с --cli-input-yaml.
--starting-token (строка)
Токен для указания точки начала постраничного вывода. Это NextToken из ранее усечённого ответа.
Примеры использования см. в разделе Постраничный вывод в руководстве пользователя AWS CLI.
--page-size (целое число)
Размер каждой страницы, получаемой при вызове AWS-сервиса. Это не влияет на количество элементов, возвращаемых в выводе команды. Установка меньшего размера страницы приводит к большему количеству вызовов AWS-сервиса, извлекая меньше элементов в каждом вызове. Это может помочь предотвратить истечение времени ожидания вызовов AWS-сервиса.
Примеры использования см. в разделе Постраничный вывод в руководстве пользователя AWS CLI.
--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 (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.
Примеры
Примечание
Для использования следующих примеров необходимо установить и настроить AWS CLI. Дополнительную информацию см. в руководстве пользователя AWS CLI в разделе «Начало работы».
Если не указано иное, все примеры используют правила цитирования Unix-подобных систем. Эти примеры нужно будет адаптировать к правилам цитирования вашей оболочки. См. раздел «Использование кавычек со строками» в руководстве пользователя AWS CLI.
Чтобы перечислить общедоступные ключи SSH, прикрепленные к пользователю IAM
Следующий пример перечисляет общедоступные ключи SSH, прикреплённые к пользователю IAM sofia.
aws iam list-ssh-public-keys \
--user-name sofia
Вывод:
{
"SSHPublicKeys": [
{
"UserName": "sofia",
"SSHPublicKeyId": "APKA1234567890EXAMPLE",
"Status": "Inactive",
"UploadDate": "2019-04-18T17:04:49+00:00"
}
]
}
Дополнительную информацию см. в разделе «Использование ключей SSH и SSH с CodeCommit» в руководстве пользователя AWS IAM.
Вывод
SSHPublicKeys -> (список)
Список общедоступных ключей SSH, назначенных пользователю IAM.
(структура)
Содержит информацию об общедоступном ключе SSH без его тела или отпечатка.
Этот тип данных используется в качестве элемента ответа в операции ListSSHPublicKeys.
UserName -> (строка)
SSHPublicKeyId -> (строка)
Status -> (строка)
Active означает, что ключ может быть использован для аутентификации в репозитории CodeCommit. Inactive означает, что ключ не может быть использован.UploadDate -> (временная метка)
IsTruncated -> (булево)
Marker, чтобы получить больше элементов. Обратите внимание, что IAM может вернуть меньше, чем количество результатов MaxItems, даже если больше результатов доступны. Рекомендуется проверять IsTruncated после каждого вызова, чтобы убедиться, что вы получили все свои результаты.Marker -> (строка)
IsTruncated равно true, этот элемент присутствует и содержит значение, которое следует использовать для параметра Marker в последующем запросе постраничного вывода.
© Copyright 2025, Amazon Web Services. Created using Sphinx.