Spec-Zone.ru › AWS CLI v2

[ aws . discovery ]

describe-export-tasks

Описание

Получение статуса одной или нескольких задач экспорта. Можно получить статус до 100 задач экспорта.

См. также: AWS API Documentation

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

Синтаксис

  describe-export-tasks
[--export-ids <value>]
[--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]

Параметры

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

Один или несколько уникальных идентификаторов, используемых для запроса статуса запроса на экспорт.

(строка)

Синтаксис:

"string" "string" ...

--filters (список)

Один или несколько фильтров.

  • AgentId - Идентификатор агента, собранные данные которого будут экспортированы

(структура)

Используется для выбора данных агента, которые нужно экспортировать. Один идентификатор агента может быть выбран для экспорта с помощью действия StartExportTask.

name -> (строка)

Одно имя ExportFilter. Поддерживаемые фильтры: agentIds .

values -> (список)

Один идентификатор агента для агента Discovery. Идентификатор агента можно найти с помощью действия DescribeAgents. Как правило, идентификатор агента ADS имеет вид o-0123456789abcdef0 .

(строка)

condition -> (строка)

Поддерживаемое условие: EQUALS

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

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

Синтаксис JSON:

[
  {
    "name": "string",
    "values": ["string", ...],
    "condition": "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
  • text
  • таблица
  • yaml
  • yaml-stream

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

Вывод

exportsInfo -> (список)

Содержит один или несколько наборов деталей запросов экспорта. Когда статус запроса SUCCEEDED, ответ включает URL-адрес ведра Amazon S3, где можно просмотреть данные в файле CSV.

(структура)

Информация о статусе экспорта обнаруженных данных. Значение представляет собой массив объектов.

exportId -> (строка)

Уникальный идентификатор, используемый для запроса экспорта.

exportStatus -> (строка)

Статус задания экспорта данных.

statusMessage -> (строка)

Сообщение о статусе, предоставленное вызывающим сторонам API.

configurationsDownloadUrl -> (строка)

URL ведра Amazon S3, где можно просмотреть экспортированные данные. URL отображается только в случае успешного экспорта.

exportRequestTime -> (временная метка)

Время начала экспорта данных.

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

Если true, экспорт информации об агенте превысил лимит размера для одного экспорта, и экспортированные данные неполны для запрошенного диапазона времени. Для решения этой проблемы выберите меньший диапазон времени для экспорта, используя startDate и endDate .

requestedStartTime -> (временная метка)

Значение параметра startTime в запросе StartExportTask. Если запрос startTime не был выполнен, этот результат не отображается в ExportInfo.

requestedEndTime -> (временная метка)

Значение endTime, используемое в запросе StartExportTask. Если запрос endTime не был выполнен, этот результат не отображается в ExportInfo.

nextToken -> (строка)

Значение nextToken для включения в последующий запрос DescribeExportTasks. Когда результаты запроса DescribeExportTasks превышают maxResults, это значение может быть использовано для получения следующей страницы результатов. Это значение равно null, когда больше результатов нет для возвращения.

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

Spec-Zone.ru

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