Spec-Zone.ru › AWS CLI v2

[ aws . ec2 ]

import-snapshot

Описание

Импортирует диск в снимок EBS.

Для получения дополнительной информации см. Импорт диска в виде снимка с использованием VM Import/Export в Руководстве пользователя VM Import/Export.

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

Синтаксис

  import-snapshot
[--client-data <value>]
[--client-token <value>]
[--description <value>]
[--disk-container <value>]
[--dry-run | --no-dry-run]
[--encrypted | --no-encrypted]
[--kms-key-id <value>]
[--role-name <value>]
[--tag-specifications <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]

Параметры

--client-data (структура)

Данные, специфичные для клиента.

Комментарий -> (строка)

Пользовательский комментарий о загрузке диска.

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

Время окончания загрузки диска.

UploadSize -> (двойное число)

Размер загруженного образа диска в GiB.

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

Время начала загрузки диска.

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

Comment=string,UploadEnd=timestamp,UploadSize=double,UploadStart=timestamp

Синтаксис JSON:

{
  "Comment": "string",
  "UploadEnd": timestamp,
  "UploadSize": double,
  "UploadStart": timestamp
}

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

Токен для обеспечения идемпотентности запросов импорта виртуальных машин.

--description (строка)

Строка описания задачи импорта снимка.

--disk-container (структура)

Информация о контейнере диска.

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

Описание импортируемого образа диска.

Формат -> (строка)

Формат импортируемого образа диска.

Допустимые значения: VHD | RAW

Url -> (строка)

URL образа диска, размещенного в Amazon S3. Может быть https URL (https://..) или URL Amazon S3 (s3://..).

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

Ведро Amazon S3 для образа диска.

S3Bucket -> (строка)

Имя ведра Amazon S3, в котором находится образ диска.

S3Key -> (строка)

Имя файла образа диска.

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

Description=string,Format=string,Url=string,UserBucket={S3Bucket=string,S3Key=string}

Синтаксис JSON:

{
  "Description": "string",
  "Format": "string",
  "Url": "string",
  "UserBucket": {
    "S3Bucket": "string",
    "S3Key": "string"
  }
}

--dry-run | --no-dry-run (булево)

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

--encrypted | --no-encrypted (булево)

Указывает, следует ли шифровать целевой снимок импортированного образа. Используется ключ KMS по умолчанию для EBS, если вы не указываете другой ключ KMS с помощью KmsKeyId. Для получения дополнительной информации см. Шифрование Amazon EBS в Руководстве пользователя Amazon Elastic Compute Cloud.

--kms-key-id (строка)

Идентификатор симметричного ключа KMS, который следует использовать при создании зашифрованного снимка. Этот параметр требуется только в случае использования ключа KMS, отличного от ключа по умолчанию; если этот параметр не указан, используется ключ KMS по умолчанию для EBS. Если указан KmsKeyId, также должен быть установлен флаг Encrypted.

Идентификатор ключа KMS может быть предоставлен в любом из следующих форматов:

  • Идентификатор ключа
  • Псевдоним ключа
  • ARN с идентификатором ключа. ARN идентификатора содержит пространство имен arn:aws:kms, за которым следует регион ключа, идентификатор учетной записи Amazon Web Services владельца ключа, пространство имен key, а затем идентификатор ключа. Например, arn:aws:kms:us-east-1 :012345678910 :key/abcd1234-a123-456a-a12b-a123b4cd56ef.
  • ARN с псевдонимом ключа. ARN псевдонима содержит пространство имен arn:aws:kms, за которым следует регион ключа, идентификатор учетной записи Amazon Web Services владельца ключа, пространство имен alias, а затем псевдоним ключа. Например, arn:aws:kms:us-east-1 :012345678910 :alias/ExampleAlias.

Amazon Web Services обрабатывает KmsKeyId асинхронно, что означает, что вызываемое действие может показаться завершенным, даже если вами предоставлен неверный идентификатор. Это действие в конечном итоге сообщит об ошибке.

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

Amazon EBS не поддерживает асимметричные ключи KMS.

--role-name (строка)

Имя роли для использования вместо роли по умолчанию «vmimport».

--tag-specifications (список)

Теги для применения к задаче импорта снимка при создании.

(структура)

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

Примечание

Список Valid Values содержит все типы ресурсов, которые могут быть помечены. Однако используемое действие может не поддерживать все эти типы ресурсов. Если вы попытаетесь пометить тип ресурса, который не поддерживается для используемого действия, вы получите ошибку.

ResourceType -> (строка)

Тип ресурса для маркировки при создании.

Tags -> (список)

Теги для применения к ресурсу.

(структура)

Описание тега.

Key -> (строка)

Ключ тега.

Ограничения: ключи тегов регистрозависимы и принимают максимум 127 символов Юникода. Не должны начинаться с aws:.

Value -> (строка)

Значение тега.

Ограничения: значения тегов регистрозависимы и принимают максимум 256 символов Юникода.

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

ResourceType=string,Tags=[{Key=string,Value=string},{Key=string,Value=string}] ...

Синтаксис JSON:

[
  {
    "ResourceType": "capacity-reservation"|"client-vpn-endpoint"|"customer-gateway"|"carrier-gateway"|"coip-pool"|"declarative-policies-report"|"dedicated-host"|"dhcp-options"|"egress-only-internet-gateway"|"elastic-ip"|"elastic-gpu"|"export-image-task"|"export-instance-task"|"fleet"|"fpga-image"|"host-reservation"|"image"|"import-image-task"|"import-snapshot-task"|"instance"|"instance-event-window"|"internet-gateway"|"ipam"|"ipam-pool"|"ipam-scope"|"ipv4pool-ec2"|"ipv6pool-ec2"|"key-pair"|"launch-template"|"local-gateway"|"local-gateway-route-table"|"local-gateway-virtual-interface"|"local-gateway-virtual-interface-group"|"local-gateway-route-table-vpc-association"|"local-gateway-route-table-virtual-interface-group-association"|"natgateway"|"network-acl"|"network-interface"|"network-insights-analysis"|"network-insights-path"|"network-insights-access-scope"|"network-insights-access-scope-analysis"|"outpost-lag"|"placement-group"|"prefix-list"|"replace-root-volume-task"|"reserved-instances"|"route-table"|"security-group"|"security-group-rule"|"service-link-virtual-interface"|"snapshot"|"spot-fleet-request"|"spot-instances-request"|"subnet"|"subnet-cidr-reservation"|"traffic-mirror-filter"|"traffic-mirror-session"|"traffic-mirror-target"|"transit-gateway"|"transit-gateway-attachment"|"transit-gateway-connect-peer"|"transit-gateway-multicast-domain"|"transit-gateway-policy-table"|"transit-gateway-route-table"|"transit-gateway-route-table-announcement"|"volume"|"vpc"|"vpc-endpoint"|"vpc-endpoint-connection"|"vpc-endpoint-service"|"vpc-endpoint-service-permission"|"vpc-peering-connection"|"vpn-connection"|"vpn-gateway"|"vpc-flow-log"|"capacity-reservation-fleet"|"traffic-mirror-filter-rule"|"vpc-endpoint-connection-device-type"|"verified-access-instance"|"verified-access-group"|"verified-access-endpoint"|"verified-access-policy"|"verified-access-trust-provider"|"vpn-connection-device-type"|"vpc-block-public-access-exclusion"|"route-server"|"route-server-endpoint"|"route-server-peer"|"ipam-resource-discovery"|"ipam-resource-discovery-association"|"instance-connect-endpoint"|"verified-access-endpoint-target"|"ipam-external-resource-verification-token"|"mac-modification-task",
    "Tags": [
      {
        "Key": "string",
        "Value": "string"
      }
      ...
    ]
  }
  ...
]

--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
  • таблица
  • 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.

Для импорта снимка

Следующий import-snapshot пример импортирует указанный диск как снимок.

aws ec2 import-snapshot \
    --description "My server VMDK" \
    --disk-container Format=VMDK,UserBucket={'S3Bucket=my-import-bucket,S3Key=vms/my-server-vm.vmdk'}

Вывод:

{
    "Description": "My server VMDK",
    "ImportTaskId": "import-snap-1234567890abcdef0",
    "SnapshotTaskDetail": {
        "Description": "My server VMDK",
        "DiskImageSize": "0.0",
        "Format": "VMDK",
        "Progress": "3",
        "Status": "active",
        "StatusMessage": "pending"
        "UserBucket": {
            "S3Bucket": "my-import-bucket",
            "S3Key": "vms/my-server-vm.vmdk"
        }
    }
}

Вывод

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

Описание задачи импорта моментального снимка.

ImportTaskId -> (строка)

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

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

Информация о задаче импорта моментального снимка.

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

Описание импортируемого образа диска.

DiskImageSize -> (двойное)

Размер диска в снимке в ГиБ.

Зашифрован -> (булево)

Указывает, зашифрован ли моментальный снимок.

Формат -> (строка)

Формат образа диска, из которого создается моментальный снимок.

KmsKeyId -> (строка)

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

Прогресс -> (строка)

Процент выполнения задачи импорта моментального снимка.

SnapshotId -> (строка)

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

Статус -> (строка)

Краткое состояние задачи импорта моментального снимка.

Сообщение о статусе -> (строка)

Подробное сообщение о состоянии задачи импорта моментального снимка.

Url -> (строка)

URL образа диска, из которого создается моментальный снимок.

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

Ведро Amazon S3 для образа диска.

S3Bucket -> (строка)

Ведро Amazon S3, из которого был создан образ диска.

S3Key -> (строка)

Имя файла образа диска.

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

Любые теги, назначенные задаче импорта моментального снимка.

(структура)

Описание тега.

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

Ключ тега.

Ограничения: Ключи тегов регистрозависимы и принимают максимум 127 символов Юникода. Не должно начинаться с aws:.

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

Значение тега.

Ограничения: Значения тегов регистрозависимы и принимают максимум 256 символов Юникода.

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

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

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