describe-image-attribute

Описание

Описывает указанный атрибут указанного AMI. Вы можете указать только один атрибут за раз.

Примечание

Порядок элементов в ответе, включая элементы вложенных структур, может различаться. Приложения не должны предполагать определенный порядок элементов.

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

Синтаксис

  describe-image-attribute
--attribute <value>
--image-id <value>
[--dry-run | --no-dry-run]
[--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]

Параметры

--attribute (строка)

Атрибут AMI.

Примечание : Атрибут blockDeviceMapping устарел. Использование этого атрибута возвращает ошибку Client.AuthFailure. Чтобы получить информацию о сопоставлениях блочных устройств для AMI, используйте действие DescribeImages.

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

description
kernel
ramdisk
launchPermission
productCodes
blockDeviceMapping
sriovNetSupport
bootMode
tpmSupport
uefiData
lastLaunchedTime
imdsSupport
deregistrationProtection

--image-id (строка)

Идентификатор AMI.

--dry-run | --no-dry-run (логическое значение)

Проверяет, есть ли у вас необходимые разрешения для действия, не выполняя сам запрос, и возвращает ответ об ошибке. Если у вас есть необходимые разрешения, ответ об ошибке — DryRunOperation. В противном случае — UnauthorizedOperation.

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

Для описания разрешений запуска для AMI

В этом примере описываются разрешения запуска для указанного AMI.

Команда:

aws ec2 describe-image-attribute --image-id ami-5731123e --attribute launchPermission

Вывод:

{
    "LaunchPermissions": [
        {
            "UserId": "123456789012"
        }
    ],
    "ImageId": "ami-5731123e",
}

Для описания кодов продуктов для AMI

В этом примере описываются коды продуктов для указанного AMI. Обратите внимание, что у этого AMI нет кодов продуктов.

Команда:

aws ec2 describe-image-attribute --image-id ami-5731123e --attribute productCodes

Вывод:

{
    "ProductCodes": [],
    "ImageId": "ami-5731123e",
}

Вывод

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

Описание для AMI.

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

Значение атрибута. Значение чувствительно к регистру.

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

Идентификатор ядра.

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

Значение атрибута. Значение чувствительно к регистру.

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

Идентификатор RAM-диска.

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

Значение атрибута. Значение чувствительно к регистру.

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

Указывает, включен ли улучшенный сетевой доступ с интерфейсом Intel 82599 Virtual Function.

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

Значение атрибута. Значение чувствительно к регистру.

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

Режим загрузки.

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

Значение атрибута. Значение чувствительно к регистру.

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

Если образ настроен для поддержки NitroTPM, значение равно v2.0.

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

Значение атрибута. Значение чувствительно к регистру.

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

Представление в формате base64 хранилища нелетучих переменных UEFI. Для получения данных UEFI используйте команду GetInstanceUefiData. Вы можете просматривать и изменять данные UEFI, используя инструмент python-uefivars на GitHub. Дополнительную информацию см. в Руководстве пользователя Amazon EC2, раздел UEFI Secure Boot.

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

Значение атрибута. Значение чувствительно к регистру.

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

Дата и время, в формате ISO 8601 , когда AMI был последний раз использован для запуска экземпляра EC2. После использования AMI для запуска экземпляра, требуется 24 часа, прежде чем это использование будет отображено.

Примечание

Данные lastLaunchedTime доступны начиная с апреля 2017 года.

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

Значение атрибута. Значение чувствительно к регистру.

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

Если v2.0, это указывает, что в AMI указан IMDSv2. Экземпляры, запущенные из этого AMI, будут иметь HttpTokens автоматически установленным в required, таким образом, по умолчанию экземпляр требует использования IMDSv2 при запросе метаданных экземпляра. Кроме того, HttpPutResponseHopLimit установлено в 2. Дополнительную информацию см. в Руководстве пользователя Amazon EC2, раздел Настройка AMI.

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

Значение атрибута. Значение чувствительно к регистру.

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

Указывает, включена ли защита от де регистрации для AMI.

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

Значение атрибута. Значение чувствительно к регистру.

ImageId -> (строка)

Идентификатор AMI.

LaunchPermissions -> (список)

Разрешения запуска.

(структура)

Описание разрешения запуска.

OrganizationArn -> (строка)

Amazon Resource Name (ARN) организации.

OrganizationalUnitArn -> (строка)

Amazon Resource Name (ARN) организационной единицы (OU).

UserId -> (строка)

Идентификатор учетной записи Amazon Web Services.

Ограничения: до 10 000 идентификаторов учетных записей могут быть указаны в одном запросе.

Group -> (строка)

Название группы.

ProductCodes -> (список)

Коды продуктов.

(структура)

Описание кода продукта.

ProductCodeId -> (строка)

Код продукта.

ProductCodeType -> (строка)

Тип кода продукта.

BlockDeviceMappings -> (список)

Записи сопоставления блочных устройств.

(структура)

Описание сопоставления блочных устройств, которое определяет тома EBS и тома памяти экземпляра, которые нужно подключить к экземпляру при запуске.

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

Параметры, используемые для автоматической настройки томов EBS при запуске экземпляра.

DeleteOnTermination -> (boolean)

Указывает, будет ли том EBS удалён при завершении работы экземпляра. Для получения дополнительной информации см. Сохранение томов Amazon EBS при завершении работы экземпляра в руководстве пользователя Amazon EC2.

Iops -> (integer)

Количество операций ввода-вывода в секунду (IOPS). Для томов типов gp3 , io1 и io2 это значение представляет собой количество выделенных IOPS для тома. Для томов gp2 это значение представляет собой базовый уровень производительности тома и скорость накопления кредитов I/O для повышения производительности.

Ниже приведены поддерживаемые значения для каждого типа тома:

gp3 : 3 000—16 000 IOPS
io1 : 100—64 000 IOPS
io2 : 100—256 000 IOPS

Для томов io2 вы можете достичь до 256 000 IOPS на экземплярах, построенных на платформе Nitro System. На других экземплярах вы можете достичь производительности до 32 000 IOPS.

Этот параметр требуется для томов io1 и io2. По умолчанию для томов gp3 значение равно 3 000 IOPS.

SnapshotId -> (string)

Идентификатор моментального снимка.

VolumeSize -> (integer)

Размер тома в GiB. Вы должны указать либо идентификатор моментального снимка, либо размер тома. Если вы указываете моментальный снимок, по умолчанию используется размер моментального снимка. Вы можете указать размер тома, равный или больший, чем размер моментального снимка.

Ниже приведены поддерживаемые размеры для каждого типа тома:

gp2 и gp3 : 1—16 384 GiB
io1 : 4—16 384 GiB
io2 : 4—65 536 GiB
st1 и sc1 : 125—16 384 GiB
standard : 1—1024 GiB

VolumeType -> (string)

Тип тома. Для получения дополнительной информации см. Типы томов Amazon EBS в руководстве пользователя Amazon EBS.

KmsKeyId -> (string)

Идентификатор (ID ключа, псевдоним ключа, ARN ключа или ARN псевдонима) управляемого пользователем ключа KMS, который нужно использовать для шифрования EBS.

Этот параметр поддерживается только для объектов BlockDeviceMapping, вызываемых с помощью RunInstances , RequestSpotFleet и RequestSpotInstances .

Throughput -> (integer)

Пропускная способность, которую поддерживает том в MiB/с.

Этот параметр допустим только для томов gp3.

Допустимый диапазон: Минимальное значение 125. Максимальное значение 1000.

OutpostArn -> (string)

ARN облачного пункта присутствия Outpost, на котором хранится моментальный снимок.

Этот параметр не поддерживается при использовании CreateImage .

Encrypted -> (boolean)

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

В любом случае вы не можете снять шифрование с зашифрованного тома.

Зашифрованные тома могут подключаться только к экземплярам, которые поддерживают шифрование Amazon EBS. Для получения дополнительной информации см. Поддерживаемые типы экземпляров.

Этот параметр не возвращается методом DescribeImageAttribute .

Для CreateImage и RegisterImage, возможность использования этого параметра и разрешённые значения зависят от типа сопоставления блочных устройств, которое вы создаёте.

Если вы создаёте сопоставление блочных устройств для **нового (пустого) тома**, вы можете использовать этот параметр и указать либо true для зашифрованного тома, либо false для незашифрованного тома. Если вы опустите этот параметр, он будет по умолчанию false (незашифрованный).
Если вы создаёте сопоставление блочных устройств из **существующего зашифрованного или незашифрованного моментального снимка**, вы должны опустить этот параметр. Если вы включите этот параметр, запрос завершится ошибкой независимо от значения, которое вы укажете.
Если вы создаёте сопоставление блочных устройств из **существующего незашифрованного тома**, вы можете использовать этот параметр, но вы должны указать false. Если вы укажете true, запрос завершится ошибкой. В этом случае рекомендуется опустить параметр.
Если вы создаёте сопоставление блочных устройств из **существующего зашифрованного тома**, вы можете использовать этот параметр и указать либо true, либо false. Однако, если вы укажете false, параметр будет проигнорирован, и сопоставление блочных устройств всегда будет зашифровано. В этом случае рекомендуется опустить параметр.

VolumeInitializationRate -> (integer)

Указывает скорость инициализации тома Amazon EBS (скорость инициализации тома) в MiB/с, с которой нужно загружать блоки моментального снимка из Amazon S3 на том. Это также известно как инициализация тома . Указание скорости инициализации тома гарантирует, что том будет инициализироваться с прогнозируемой и постоянной скоростью после создания.

Этот параметр поддерживается только для томов, созданных из моментальных снимков. Опустите этот параметр, если:

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

Примечание

Если вы указываете моментальный снимок, включённый для быстрого восстановления моментального снимка, и скорость инициализации тома, том будет инициализирован с указанной скоростью вместо быстрого восстановления моментального снимка.

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

Для получения дополнительной информации см. Инициализация томов Amazon EBS в руководстве пользователя Amazon EC2.

Этот параметр не поддерживается при использовании CreateImage .

Допустимый диапазон: 100—300 MiB/с

NoDevice -> (string)

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

DeviceName -> (string)

Имя устройства (например, /dev/sdh или xvdh).

VirtualName -> (string)

Виртуальное имя устройства (ephemeral N). Тома памяти экземпляра нумеруются, начиная с 0. Экземпляр типа с 2 доступными томами памяти экземпляра может указывать сопоставления для ephemeral0 и ephemeral1 . Количество доступных томов памяти экземпляра зависит от типа экземпляра. После подключения к экземпляру вы должны смонтировать том.

Тома NVMe памяти экземпляра автоматически перечисляются и получают имя устройства. Их включение в сопоставление блочных устройств не влияет на работу.

Ограничения: для экземпляров M3 вы должны указать тома памяти экземпляра в сопоставлении блочных устройств для экземпляра. При запуске экземпляра M3 мы игнорируем любые тома памяти экземпляра, указанные в сопоставлении блочных устройств для AMI.

END_OF_DOCUMENT_MARKER