Spec-Zone.ru › AWS CLI v2

[ aws . iam ]

получить-общедоступный-ключ-ssh

Описание

Извлекает указанный общедоступный ключ SSH, включая метаданные о ключе.

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

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

Синтаксис

  get-ssh-public-key
--user-name <value>
--ssh-public-key-id <value>
--encoding <value>
[--cli-input-json | --cli-input-yaml]
[--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.

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

--ssh-public-key-id (строка)

Уникальный идентификатор общедоступного ключа SSH.

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

--encoding (строка)

Указывает формат кодирования общедоступного ключа для использования в ответе. Чтобы извлечь общедоступный ключ в формате ssh-rsa, используйте SSH. Чтобы извлечь общедоступный ключ в формате PEM, используйте PEM.

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

  • SSH
  • PEM

--cli-input-json | --cli-input-yaml (строка) Читает аргументы из предоставленной JSON-строки. JSON-строка соответствует формату, указанному в --generate-cli-skeleton. Если другие аргументы предоставлены в командной строке, эти значения переопределят значения, предоставленные через JSON. Невозможно передавать произвольные двоичные значения с помощью значения, предоставленного через JSON, так как строка будет интерпретирована буквально. Это не может быть указано вместе с --cli-input-yaml.

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

Пример 1: Извлечение общедоступного ключа SSH, прикрепленного к пользователю IAM, в формате SSH

Следующая get-ssh-public-key команда извлекает указанный общедоступный ключ SSH из пользователя IAM sofia. Вывод находится в кодировке SSH.

aws iam get-ssh-public-key \
    --user-name sofia \
    --ssh-public-key-id APKA123456789EXAMPLE \
    --encoding SSH

Вывод:

{
    "SSHPublicKey": {
        "UserName": "sofia",
        "SSHPublicKeyId": "APKA123456789EXAMPLE",
        "Fingerprint": "12:34:56:78:90:ab:cd:ef:12:34:56:78:90:ab:cd:ef",
        "SSHPublicKeyBody": "ssh-rsa <<long encoded SSH string>>",
        "Status": "Inactive",
        "UploadDate": "2019-04-18T17:04:49+00:00"
    }
}

Пример 2: Извлечение общедоступного ключа SSH, прикрепленного к пользователю IAM, в формате PEM

Следующая get-ssh-public-key команда извлекает указанный общедоступный ключ SSH из пользователя IAM sofia. Вывод находится в кодировке PEM.

aws iam get-ssh-public-key \
    --user-name sofia \
    --ssh-public-key-id APKA123456789EXAMPLE \
    --encoding PEM

Вывод:

{
    "SSHPublicKey": {
        "UserName": "sofia",
        "SSHPublicKeyId": "APKA123456789EXAMPLE",
        "Fingerprint": "12:34:56:78:90:ab:cd:ef:12:34:56:78:90:ab:cd:ef",
        "SSHPublicKeyBody": ""-----BEGIN PUBLIC KEY-----\n<<long encoded PEM string>>\n-----END PUBLIC KEY-----\n"",
        "Status": "Inactive",
        "UploadDate": "2019-04-18T17:04:49+00:00"
    }
}

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

Вывод

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

Структура, содержащая подробности о общедоступном ключе SSH.

UserName -> (строка)

Имя пользователя IAM, связанного с общедоступным ключом SSH.

SSHPublicKeyId -> (строка)

Уникальный идентификатор общедоступного ключа SSH.

Fingerprint -> (строка)

MD5-хеш общедоступного ключа SSH.

SSHPublicKeyBody -> (строка)

Общедоступный ключ SSH.

Status -> (строка)

Состояние общедоступного ключа SSH. Active означает, что ключ может использоваться для аутентификации в репозитории CodeCommit. Inactive означает, что ключ не может использоваться.

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

Дата и время загрузки общедоступного ключа SSH в формате ISO 8601.

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

Spec-Zone.ru

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