Spec-Zone.ru › AWS CLI v2

[ aws . lightsail ]

get-export-snapshot-records

Описание

Возвращает все записи экспорта моментальных снимков, созданные в результате операции export snapshot.

Запись экспорта моментального снимка можно использовать для создания нового экземпляра Amazon EC2 и его связанных ресурсов с помощью действия CreateCloudFormationStack.

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

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

Синтаксис

  get-export-snapshot-records
[--cli-input-json | --cli-input-yaml]
[--starting-token <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]

Параметры

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

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

Токен для указания начала постраничного извлечения. Это NextToken из ранее усеченного ответа.

Примеры использования см. в разделе Постраничность в Руководстве пользователя AWS Command Line Interface.

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

Общее количество элементов для возврата в выводе команды. Если общее количество доступных элементов превышает указанное значение, в выводе команды предоставляется NextToken. Для возобновления постраничного извлечения укажите значение NextToken в аргументе starting-token последующей команды. Не используйте элемент ответа NextToken напрямую вне AWS CLI.

Примеры использования см. в разделе Постраничность в Руководстве пользователя AWS Command Line Interface.

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

Вывод

exportSnapshotRecords -> (список)

Список объектов, описывающих записи экспорта моментальных снимков.

(структура)

Описывает запись экспорта моментального снимка.

name -> (строка)

Имя записи экспорта моментального снимка.

arn -> (строка)

Amazon Resource Name (ARN) записи экспорта моментального снимка.

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

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

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

AWS-регион и зона доступности, в которых расположена запись экспорта моментального снимка.

availabilityZone -> (строка)

Зона доступности. Следует формату us-east-2a (регистрозависимо).

regionName -> (строка)

Имя региона Amazon Web Services.

resourceType -> (строка)

Тип ресурса Lightsail (ExportSnapshotRecord).

state -> (строка)

Состояние записи экспорта моментального снимка.

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

Список объектов, описывающих источник записи экспорта моментального снимка.

resourceType -> (строка)

Тип ресурса Lightsail (InstanceSnapshot или DiskSnapshot).

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

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

name -> (строка)

Имя исходного экземпляра или моментального снимка диска.

arn -> (строка)

Amazon Resource Name (ARN) исходного экземпляра или моментального снимка диска.

fromResourceName -> (строка)

Имя исходного экземпляра или диска моментального снимка.

fromResourceArn -> (строка)

Amazon Resource Name (ARN) исходного экземпляра или диска моментального снимка.

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

Список объектов, описывающих моментальный снимок экземпляра.

fromBundleId -> (строка)

Идентификатор пакета, из которого был создан исходный экземпляр (micro_x_x).

fromBlueprintId -> (строка)

Идентификатор чертежа, из которого был создан исходный экземпляр (amazon_linux_2023).

fromDiskInfo -> (список)

Список объектов, описывающих диски, которые были подключены к исходному экземпляру.

(структура)

Описывает диск.

name -> (строка)

Имя диска.

path -> (строка)

Путь к диску.

sizeInGb -> (целое число)

Размер диска в ГБ (32).

isSystemDisk -> (логическое значение)

Логическое значение, указывающее, является ли этот диск системным диском (имеет на нём загруженную операционную систему).

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

Список объектов, описывающих моментальный снимок диска.

sizeInGb -> (целое число)

Размер диска в ГБ (32).

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

Список объектов, описывающих место назначения записи экспорта моментального снимка.

id -> (строка)

Идентификатор ресурса, созданного в пункте назначения.

service -> (строка)

Сервис назначения записи.

nextPageToken -> (строка)

Токен для перехода к следующей странице результатов запроса.

Токен следующей страницы не возвращается, если больше результатов отобразить не нужно.

Чтобы получить следующую страницу результатов, выполните другой запрос GetExportSnapshotRecords и укажите токен следующей страницы с помощью параметра pageToken.

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

Spec-Zone.ru

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