describe-images

Описание

Описывает указанные образы (AMIs, AKIs и ARIs), доступные вам, или все доступные вам образы.

Доступные вам образы включают публичные образы, частные образы, которые вы владеете, и частные образы, принадлежащие другим учетным записям Amazon Web Services, для которых у вас есть явные права запуска.

Недавно дерегистрированные образы появляются в результатах в течение короткого интервала, а затем возвращают пустые результаты. После завершения работы всех экземпляров, которые ссылаются на дерегистрированный AMI, указание идентификатора образа в конечном итоге вернёт ошибку, указывающую, что идентификатор AMI не найден.

Когда Allowed AMIs установлено в enabled , в результатах возвращаются только разрешенные образы, при этом поле imageAllowed установлено в true для каждого образа. В audit-mode поле imageAllowed установлено в true для образов, соответствующих критериям Allowed AMIs учетной записи, и в false для образов, которые не соответствуют этим критериям. Для получения дополнительной информации см. EnableAllowedImagesSettings.

API Amazon EC2 использует модель конечной согласованности. Это означает, что результат API-команды, которую вы выполняете для создания или изменения ресурсов, может не быть немедленно доступен для всех последующих команд, которые вы выполняете. Для руководства по управлению конечной согласованностью см. раздел Конечная согласованность в API Amazon EC2 в Руководстве разработчика Amazon EC2.

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

describe-images — это операция с постраничной передачей данных. Для получения всего набора результатов могут быть выполнены несколько API-вызовов. Вы можете отключить постраничную передачу данных, указав аргумент --no-paginate. При использовании --output text и аргумента --query в ответе с постраничной передачей данных аргумент --query должен извлекать данные из результатов следующих выражений запроса: Images

Синтаксис

  describe-images
[--executable-users <value>]
[--image-ids <value>]
[--owners <value>]
[--include-deprecated | --no-include-deprecated]
[--include-disabled | --no-include-disabled]
[--dry-run | --no-dry-run]
[--filters <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <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]

Параметры

--executable-users (список)

Синтаксис:

"string" "string" ...

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

Синтаксис:

"string" "string" ...

--owners (список)

Синтаксис:

"string" "string" ...

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

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

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

--filters (список)

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

Name=string,Values=string,string ...

Синтаксис JSON:

[
  {
    "Name": "string",
    "Values": ["string", ...]
  }
  ...
]

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

--starting-token (строка)

--page-size (целое число)

--max-items (целое число)

--generate-cli-skeleton (строка) Выводит JSON-скелет в стандартный вывод без отправки запроса к API. Если указано без значения или со значением input, выводит пример JSON-ввода, который можно использовать в качестве аргумента для --cli-input-json. Аналогично, если указано yaml-input, он выведет пример YAML-ввода, который можно использовать с --cli-input-yaml. Если указано значение output, оно проверит входные данные команды и вернет пример выходных данных JSON для этой команды. Сгенерированный JSON-скелет не является стабильным между версиями AWS CLI, и нет гарантий обратной совместимости в сгенерированном JSON-скелете.

Общие параметры

--debug (boolean)

Включить отладку протоколирования.

--endpoint-url (string)

Заменить стандартный URL команды заданным URL.

--no-verify-ssl (boolean)

По умолчанию AWS CLI использует SSL при общении с AWS-сервисами. Для каждого SSL-соединения AWS CLI будет проверять SSL-сертификаты. Этот параметр переопределяет поведение проверки SSL-сертификатов по умолчанию.

--no-paginate (boolean)

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

--output (string)

Стиль форматирования вывода команды.

• json
• text
• table
• yaml
• yaml-stream

--query (string)

Запрос JMESPath для фильтрации данных ответа.

--profile (string)

Использовать определенный профиль из файла учетных данных.

--region (string)

Регион для использования. Переопределяет настройки конфигурации/окружения.

--version (string)

Отобразить версию этого инструмента.

--color (string)

Включить/выключить цветной вывод.

• on
• off
• auto

--no-sign-request (boolean)

Не подписывать запросы. Учетные данные не будут загружены, если этот параметр задан.

--ca-bundle (string)

Файл сертификатов CA для проверки SSL-сертификатов. Переопределяет настройки конфигурации/окружения.

--cli-read-timeout (int)

Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию — 60 секунд.

--cli-connect-timeout (int)

Максимальное время подключения сокета в секундах. Если значение установлено в 0, подключение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию — 60 секунд.

--cli-binary-format (string)

Стиль форматирования, используемый для двоичных блоков. По умолчанию используется формат 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 (boolean)

Отключить пейджер CLI для вывода.

--cli-auto-prompt (boolean)

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

--no-cli-auto-prompt (boolean)

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

Примеры

Пример 1: Описание AMI

Следующий describe-images пример описывает указанный AMI в указанном регионе.

aws ec2 describe-images \
    --region us-east-1 \
    --image-ids ami-1234567890EXAMPLE

Вывод:

{
    "Images": [
        {
            "VirtualizationType": "hvm",
            "Description": "Provided by Red Hat, Inc.",
            "PlatformDetails": "Red Hat Enterprise Linux",
            "EnaSupport": true,
            "Hypervisor": "xen",
            "State": "available",
            "SriovNetSupport": "simple",
            "ImageId": "ami-1234567890EXAMPLE",
            "UsageOperation": "RunInstances:0010",
            "BlockDeviceMappings": [
                {
                    "DeviceName": "/dev/sda1",
                    "Ebs": {
                        "SnapshotId": "snap-111222333444aaabb",
                        "DeleteOnTermination": true,
                        "VolumeType": "gp2",
                        "VolumeSize": 10,
                        "Encrypted": false
                    }
                }
            ],
            "Architecture": "x86_64",
            "ImageLocation": "123456789012/RHEL-8.0.0_HVM-20190618-x86_64-1-Hourly2-GP2",
            "RootDeviceType": "ebs",
            "OwnerId": "123456789012",
            "RootDeviceName": "/dev/sda1",
            "CreationDate": "2019-05-10T13:17:12.000Z",
            "Public": true,
            "ImageType": "machine",
            "Name": "RHEL-8.0.0_HVM-20190618-x86_64-1-Hourly2-GP2"
        }
    ]
}

Дополнительную информацию см. в разделе «Amazon Machine Images (AMI)» в Руководстве пользователя Amazon EC2.

Пример 2: Описание AMI на основе фильтров

Следующий describe-images пример описывает Windows AMI, предоставляемые Amazon, основанные на Amazon EBS.

aws ec2 describe-images \
    --owners amazon \
    --filters "Name=platform,Values=windows" "Name=root-device-type,Values=ebs"

Пример вывода для describe-images см. в Примере 1.

Дополнительные примеры использования фильтров см. в разделе «Перечисление и фильтрация ресурсов» в Руководстве пользователя Amazon EC2.

Пример 3: Описание AMI на основе тегов

Следующий describe-images пример описывает все AMI, имеющие тег Type=Custom. В примере используется параметр --query для отображения только идентификаторов AMI.

aws ec2 describe-images \
    --filters "Name=tag:Type,Values=Custom" \
    --query 'Images[*].[ImageId]' \
    --output text

Вывод:

ami-1234567890EXAMPLE
ami-0abcdef1234567890

Дополнительные примеры использования фильтров по тегам см. в разделе «Работа с тегами» в Руководстве пользователя Amazon EC2.

Вывод

NextToken -> (строка)

Images -> (список)