Spec-Zone.ru › AWS CLI v2

[ aws . iam ]

get-instance-profile

Описание

Получает информацию о заданном профиле экземпляра, включая путь к профилю экземпляра, GUID, ARN и роль. Дополнительную информацию о профилях экземпляров см. в руководстве пользователя по IAM (Using instance profiles).

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

Синтаксис

  get-instance-profile
--instance-profile-name <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]

Параметры

--instance-profile-name (строка)

Имя профиля экземпляра, о котором требуется получить информацию.

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

--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 в руководстве пользователя AWS CLI.

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

Для получения информации о профиле экземпляра

Следующая команда get-instance-profile получает информацию о профиле экземпляра с именем ExampleInstanceProfile.

aws iam get-instance-profile \
    --instance-profile-name ExampleInstanceProfile

Вывод:

{
    "InstanceProfile": {
        "InstanceProfileId": "AID2MAB8DPLSRHEXAMPLE",
        "Roles": [
            {
                "AssumeRolePolicyDocument": "<URL-encoded-JSON>",
                "RoleId": "AIDGPMS9RO4H3FEXAMPLE",
                "CreateDate": "2013-01-09T06:33:26Z",
                "RoleName": "Test-Role",
                "Path": "/",
                "Arn": "arn:aws:iam::336924118301:role/Test-Role"
            }
        ],
        "CreateDate": "2013-06-12T23:52:02Z",
        "InstanceProfileName": "ExampleInstanceProfile",
        "Path": "/",
        "Arn": "arn:aws:iam::336924118301:instance-profile/ExampleInstanceProfile"
    }
}

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

Вывод

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

Структура, содержащая подробности о профиле экземпляра.

Путь -> (строка)

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

Имя профиля экземпляра -> (строка)

Имя, определяющее профиль экземпляра.

Идентификатор профиля экземпляра -> (строка)

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

Arn -> (строка)

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

Дата создания -> (метка времени)

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

Роли -> (список)

Роль, связанная с профилем экземпляра.

(структура)

Содержит информацию об IAM-роли. Эта структура возвращается как элемент ответа в нескольких операциях API, которые взаимодействуют с ролями.

Путь -> (строка)

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

Имя роли -> (строка)

Наглядное имя, определяющее роль.

Идентификатор роли -> (строка)

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

Arn -> (строка)

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

Дата создания -> (метка времени)

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

Документ политики AssumeRole -> (строка)

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

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

Описание роли, предоставленное вами.

Максимальная продолжительность сеанса -> (целое число)

Максимальная продолжительность сеанса (в секундах) для указанной роли. Любой, кто использует командную строку или API для принятия роли, может указать продолжительность с помощью необязательного параметра API DurationSeconds или параметра командной строки duration-seconds.

Предел разрешений -> (структура)

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

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

Тип предела разрешений -> (строка)

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

Arn предела разрешений -> (строка)

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

Теги -> (список)

Список тегов, прикрепленных к роли. Дополнительную информацию о тегах см. в разделе Тегирование ресурсов IAM в руководстве по IAM.

(структура)

Структура, представляющая предоставленные пользователем метаданные, которые могут быть связаны с IAM-ресурсом. Дополнительную информацию о тегах см. в разделе Тегирование ресурсов IAM в руководстве по IAM.

Ключ -> (строка)

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

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

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

Примечание

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

Последнее использование роли -> (структура)

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

Дата последнего использования -> (метка времени)

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

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

Регион -> (строка)

Название Amazon Web Services региона, в котором роль была использована в последний раз.

Теги -> (список)

Список тегов, прикрепленных к профилю экземпляра. Дополнительную информацию о тегах см. в разделе Тегирование ресурсов IAM в руководстве по IAM.

(структура)

Структура, представляющая предоставленные пользователем метаданные, которые могут быть связаны с IAM-ресурсом. Дополнительную информацию о тегах см. в разделе Тегирование ресурсов IAM в руководстве по IAM.

Ключ -> (строка)

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

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

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

Примечание

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

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

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

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