Spec-Zone.ru › AWS CLI v2

[ aws . discovery ]

describe-import-tasks

Описание

Возвращает массив задач импорта для вашей учетной записи, включая информацию о статусе, времени, идентификаторах, URL-адрес объекта Amazon S3 для файла импорта и многое другое.

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

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

Синтаксис

  describe-import-tasks
[--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]

Параметры

--filters (список)

Массив пар «имя-значение», которые вы предоставляете для фильтрации результатов запроса DescribeImportTask до определенного подмножества результатов. В настоящее время для фильтров не поддерживаются символы подстановки.

(структура)

Пара «имя-значение» элементов, которые можно использовать для фильтрации результатов при запросе задач импорта. В настоящее время для фильтров не поддерживаются символы подстановки.

Примечание

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

name -> (строка)

Имя, статус или идентификатор задачи импорта для конкретной задачи импорта.

values -> (список)

Массив строк, которые можно предоставить для сопоставления с определенным именем, статусом или идентификатором задачи импорта, чтобы отфильтровать результаты запросов задач импорта.

(строка)

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

name=string,values=string,string ...

Синтаксис JSON:

[
  {
    "name": "IMPORT_TASK_ID"|"STATUS"|"NAME"|"FILE_CLASSIFICATION",
    "values": ["string", ...]
  }
  ...
]

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

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

Токен, указывающий, с какой точки начать постраничный вывод. Это NextToken из ранее обрезанного ответа.

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

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

Размер каждой страницы, получаемой при вызове AWS-сервиса. Это не влияет на количество элементов, возвращаемых в выводе команды. Установка меньшего размера страницы приводит к большему количеству вызовов AWS-сервиса, извлекая меньшее количество элементов в каждом вызове. Это может помочь предотвратить истечение времени ожидания вызовов AWS-сервиса.

Примеры использования см. в разделе Постраничный вывод в Руководстве пользователя 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.

Вывод

nextToken -> (строка)

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

tasks -> (список)

Возвращаемый массив задач импорта, которые соответствуют любым примененным фильтрам, до указанного максимального количества результатов.

(структура)

Массив информации, связанной с запросом задачи импорта, включая информацию о статусе, времени, идентификаторах, URL-адрес объекта Amazon S3 для файла импорта и многое другое.

importTaskId -> (строка)

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

clientRequestToken -> (строка)

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

name -> (строка)

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

importUrl -> (строка)

URL-адрес файла импорта, который вы загрузили в Amazon S3.

status -> (строка)

Статус задачи импорта. Задача импорта может иметь статус IMPORT_COMPLETE, и при этом некоторые записи могут не импортироваться из общего запроса. Более подробную информацию можно найти в загружаемом архиве, определенном в поле errorsAndFailedEntriesZip, или в консоли управления Migration Hub.

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

Время отправки запроса на задачу импорта в формате Unix-временной метки.

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

Время завершения запроса задачи импорта в формате Unix-временной метки.

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

Время удаления запроса задачи импорта в формате Unix-временной метки.

fileClassification -> (строка)

Тип файла, обнаруженный задачей импорта.

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

Общее количество записей сервера в файле импорта, которые были успешно импортированы.

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

Общее количество записей сервера в файле импорта, которые не были импортированы.

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

Общее количество записей приложений в файле импорта, которые были успешно импортированы.

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

Общее количество записей приложений в файле импорта, которые не были импортированы.

errorsAndFailedEntriesZip -> (строка)

Ссылка на сжатую папку архива (в формате ZIP), содержащую журнал ошибок и файл неудачных записей. Вы можете использовать эти два файла для быстрого определения записей, которые не были импортированы, причин неудачи и исправления этих записей. После этого вы можете загрузить исправленный файл в свой Amazon S3-ковёш и создать новый запрос задачи импорта.

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

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

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

Spec-Zone.ru

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