Spec-Zone.ru › AWS CLI v2

[ aws . ec2 ]

modify-image-attribute

Описание

Изменяет указанный атрибут указанного AMI. Вы можете указать только один атрибут за раз.

Для указания атрибута можно использовать параметр Attribute или один из следующих параметров: Description , ImdsSupport или LaunchPermission.

Изображения с кодом продукта Amazon Web Services Marketplace не могут быть сделаны общедоступными.

Для включения расширенного атрибута сетевой поддержки SriovNetSupport для изображения, включите SriovNetSupport на экземпляре и создайте AMI из экземпляра.

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

Синтаксис

  modify-image-attribute
[--attribute <value>]
[--description <value>]
--image-id <value>
[--launch-permission <value>]
[--operation-type <value>]
[--product-codes <value>]
[--user-groups <value>]
[--user-ids <value>]
[--value <value>]
[--organization-arns <value>]
[--organizational-unit-arns <value>]
[--imds-support <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 (строка)

Имя атрибута, который нужно изменить.

Допустимые значения: description | imdsSupport | launchPermission

--description (структура)

Новое описание для AMI.

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

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

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

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

--launch-permission (структура)

Новая разрешающая permission для запуска AMI.

Добавить -> (список)

Идентификатор учетной записи Amazon Web Services, ARN организации или ARN подразделения для добавления в список разрешений на запуск AMI.

(структура)

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

OrganizationArn -> (строка)

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

OrganizationalUnitArn -> (строка)

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

UserId -> (строка)

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

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

Group -> (строка)

Имя группы.

Удалить -> (список)

Идентификатор учетной записи Amazon Web Services, ARN организации или ARN подразделения для удаления из списка разрешений на запуск AMI.

(структура)

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

OrganizationArn -> (строка)

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

OrganizationalUnitArn -> (строка)

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

UserId -> (строка)

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

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

Group -> (строка)

Имя группы.

Сокращенный синтаксис:

Add=[{OrganizationArn=string,OrganizationalUnitArn=string,UserId=string,Group=string},{OrganizationArn=string,OrganizationalUnitArn=string,UserId=string,Group=string}],Remove=[{OrganizationArn=string,OrganizationalUnitArn=string,UserId=string,Group=string},{OrganizationArn=string,OrganizationalUnitArn=string,UserId=string,Group=string}]

Синтаксис JSON:

{
  "Add": [
    {
      "OrganizationArn": "string",
      "OrganizationalUnitArn": "string",
      "UserId": "string",
      "Group": "all"
    }
    ...
  ],
  "Remove": [
    {
      "OrganizationArn": "string",
      "OrganizationalUnitArn": "string",
      "UserId": "string",
      "Group": "all"
    }
    ...
  ]
}

--operation-type (строка)

Тип операции. Этот параметр можно использовать только в том случае, если параметр Attribute равен launchPermission.

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

  • add
  • remove

--product-codes (список)

Не поддерживается.

(строка)

Синтаксис:

"string" "string" ...

--user-groups (список)

Пользовательские группы. Этот параметр можно использовать только в том случае, если параметр Attribute равен launchPermission.

(строка)

Синтаксис:

"string" "string" ...

--user-ids (список)

Идентификаторы учетных записей Amazon Web Services. Этот параметр можно использовать только в том случае, если параметр Attribute равен launchPermission.

(строка)

Синтаксис:

"string" "string" ...

--value (строка)

Значение изменяемого атрибута. Этот параметр можно использовать только в том случае, если параметр Attribute равен description или imdsSupport.

--organization-arns (список)

Amazon Resource Name (ARN) организации. Этот параметр можно использовать только в том случае, если параметр Attribute равен launchPermission.

(строка)

Синтаксис:

"string" "string" ...

--organizational-unit-arns (список)

Amazon Resource Name (ARN) организационной единицы (OU). Этот параметр можно использовать только в том случае, если параметр Attribute равен launchPermission.

(строка)

Синтаксис:

"string" "string" ...

--imds-support (структура)

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

Предупреждение

Не используйте этот параметр, если ваше программное обеспечение AMI не поддерживает IMDSv2. После установки значения на v2.0 его нельзя изменить. Единственный способ «сбросить» ваш AMI — создать новый 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
  • 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-auto-prompt (логическое значение)

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

--no-cli-auto-prompt (логическое значение)

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

Примеры

Примечание

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

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

Пример 1: Чтобы сделать AMI общедоступным

Следующий modify-instance-attribute пример делает указанный AMI общедоступным.

aws ec2 modify-image-attribute \
    --image-id ami-5731123e \
    --launch-permission "Add=[{Group=all}]"

Эта команда не выводит ничего на экран.

Пример 2: Чтобы сделать AMI закрытым

Следующий modify-instance-attribute пример делает указанный AMI закрытым.

aws ec2 modify-image-attribute \
    --image-id ami-5731123e \
    --launch-permission "Remove=[{Group=all}]"

Эта команда не выводит ничего на экран.

Пример 3: Чтобы предоставить разрешение на запуск учетной записи AWS

Следующий modify-instance-attribute пример предоставляет разрешения на запуск указанной учетной записи AWS.

aws ec2 modify-image-attribute \
    --image-id ami-5731123e \
    --launch-permission "Add=[{UserId=123456789012}]"

Эта команда не выводит ничего на экран.

Пример 4: Чтобы отозвать разрешение на запуск у учетной записи AWS

Следующий modify-instance-attribute пример отзывает разрешения на запуск у указанной учетной записи AWS.

aws ec2 modify-image-attribute \
    --image-id ami-5731123e \
    --launch-permission "Remove=[{UserId=123456789012}]"

Вывод

Ничего

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

Spec-Zone.ru

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